DOCS(protocol): Integrate network protocol documentation #6623
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Graphic indicated crypt setup would be sent before client authenticated.
Protobuf project moved to github.
Update protobuf link
- Better description of the Opus/CELT packets (terminator/continuation bit). - Fixed the general text from pre-Opus era. - Better rst formatting for tables. - Split some of the more confusing tables into multiple parts. - Some section reordering for more logical order. - Some other stuff I probably forgot.
Added configuration for using the RTD theme locally. THis requires the rtd theme to be installed on the local machine. See https://github.com/snide/sphinx_rtd_theme
Fixed the link to point to the current documentation and updated the Mumble version number.
Voice Data & random tweaks
* Use it/its for the "client" to be consistent with the rest of the docs * Use neutral pronouns (they/them) for user/speaker
Fix use of pronouns
Integrates our network protocol docs [1][2]. This will allow us to drop the separate repository. Git history is preserved through adding/merging with/through git subtree. via ``` git subtree add --prefix docs/dev/network-protocol https://github.com/mumble-voip/mumble-protocol.git master ``` [1]: https://github.com/mumble-voip/mumble-protocol [2]: https://mumble-protocol.readthedocs.io/ --- Add 'docs/dev/network-protocol/' from commit 'b0d142143c5c37797d787fd7f71eb172dd1219ad' git-subtree-dir: docs/dev/network-protocol git-subtree-mainline: 65462b4 git-subtree-split: b0d1421
Dropping the resources for Sphinx documentation generation drops support for generating this documentation into various formats (see make file; html, epub, and other less useful ones). This network protocol documentation is the odd one out compared to our other documentation. The only one with this system. Diverse tech has a maintenance cost, and the previous distance to our code made more likely to be missed for updates and discovery. Handling only the network protocol documentation in this way feels disconnected/diverging. Although readers may use the docs to implement clients and servers against only the docs, the question is whether the technology and maintenance additions are worth it. Having simple structured text documentation files should serve us well enough. It does for other developer documentation / documentation for developers.
In a folder, GitHub shows a README by default, below the file list. Combining the index.rst and introduction.rst, with text fixups, will serve as an appropriate landing page/doc.
|
What are your thoughts on this @Krzmbrzl @davidebeatrici ? |
davidebeatrici
approved these changes
Dec 9, 2024
There was a problem hiding this comment.
What's your opinion on keeping the rst format?
The content seems simple enough, conversion seems feasible. That won't be part of this MR changeset though.
Ideally we should use a single format (that we're also familiar in), but I don't see an eventual conversion as a high priority task.
I would say it depends on how many and what kind of changes we're planning to do.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Replace separate repo and website with documentation files in structured text format.
Note that the author and change history from the repository is preserved through git subtree adding/merging. Those original commits do not follow the commit message format conventions of this repository. My integration and fixup commits that follow do.
Stuff not related to the documentation itself is being dropped. Namely the Sphinx (python-based docs generator) configuration.
The file
README.rstis introduced to serve the new index file and so GitHub shows its content when accessing the folder.Currently, the documentation is in reStructuredText
.rstformat rather than Markdown (we usually use Markdown.md). This MR does not change that.What's your opinion on keeping the rst format?
The content seems simple enough, conversion seems feasible. That won't be part of this MR changeset though.
Followup to #6621. You can preview GitHub rendering here.