-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCS(protocol): Integrate network protocol documentation #6623
base: master
Are you sure you want to change the base?
DOCS(protocol): Integrate network protocol documentation #6623
Commits on Dec 10, 2012
-
Configuration menu - View commit details
-
Copy full SHA for 36b4fbe - Browse repository at this point
Copy the full SHA 36b4fbeView commit details
Commits on Jul 2, 2013
-
Configuration menu - View commit details
-
Copy full SHA for 43c4490 - Browse repository at this point
Copy the full SHA 43c4490View commit details
Commits on Jan 19, 2015
-
Configuration menu - View commit details
-
Copy full SHA for 2bb8bf8 - Browse repository at this point
Copy the full SHA 2bb8bf8View commit details
Commits on Mar 14, 2015
-
Graphic indicated crypt setup would be sent before client authenticated.
Configuration menu - View commit details
-
Copy full SHA for f7d8789 - Browse repository at this point
Copy the full SHA f7d8789View commit details
Commits on Mar 28, 2015
-
Configuration menu - View commit details
-
Copy full SHA for 4569ec0 - Browse repository at this point
Copy the full SHA 4569ec0View commit details -
Configuration menu - View commit details
-
Copy full SHA for 194a25c - Browse repository at this point
Copy the full SHA 194a25cView commit details
Commits on May 3, 2015
-
- 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.
Configuration menu - View commit details
-
Copy full SHA for c347f50 - Browse repository at this point
Copy the full SHA c347f50View commit details -
Added RTD theme reference for local testing
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
Configuration menu - View commit details
-
Copy full SHA for b485ab1 - Browse repository at this point
Copy the full SHA b485ab1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9954b29 - Browse repository at this point
Copy the full SHA 9954b29View commit details -
Fixed the link to point to the current documentation and updated the Mumble version number.
Configuration menu - View commit details
-
Copy full SHA for ea764aa - Browse repository at this point
Copy the full SHA ea764aaView commit details -
Configuration menu - View commit details
-
Copy full SHA for a01b4f2 - Browse repository at this point
Copy the full SHA a01b4f2View commit details
Commits on Jan 6, 2022
-
* Use it/its for the "client" to be consistent with the rest of the docs * Use neutral pronouns (they/them) for user/speaker
Configuration menu - View commit details
-
Copy full SHA for ca56cf3 - Browse repository at this point
Copy the full SHA ca56cf3View commit details -
Merge pull request #4 from deletescape/pronoun-fix
Fix use of pronouns
Configuration menu - View commit details
-
Copy full SHA for 7c3435d - Browse repository at this point
Copy the full SHA 7c3435dView commit details
Commits on Nov 13, 2022
-
Configuration menu - View commit details
-
Copy full SHA for 1e3d3b5 - Browse repository at this point
Copy the full SHA 1e3d3b5View commit details -
Configuration menu - View commit details
-
Copy full SHA for b0d1421 - Browse repository at this point
Copy the full SHA b0d1421View commit details
Commits on Nov 3, 2024
-
DOCS(protocol): Integrate network protocol documentation
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
Configuration menu - View commit details
-
Copy full SHA for d05262a - Browse repository at this point
Copy the full SHA d05262aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 208dbc1 - Browse repository at this point
Copy the full SHA 208dbc1View commit details -
DOCS(protocol): Drop Sphinx configuration
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.
Configuration menu - View commit details
-
Copy full SHA for b39bbf2 - Browse repository at this point
Copy the full SHA b39bbf2View commit details -
DOCS(protocol): Combine README.rst
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.
Configuration menu - View commit details
-
Copy full SHA for eae0eac - Browse repository at this point
Copy the full SHA eae0eacView commit details -
Configuration menu - View commit details
-
Copy full SHA for be8874f - Browse repository at this point
Copy the full SHA be8874fView commit details