Skip to content
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

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Commits on Dec 10, 2012

  1. Configuration menu
    Copy the full SHA
    36b4fbe View commit details
    Browse the repository at this point in the history

Commits on Jul 2, 2013

  1. Configuration menu
    Copy the full SHA
    43c4490 View commit details
    Browse the repository at this point in the history

Commits on Jan 19, 2015

  1. Update voice_data.rst to include Opus voice packets.

    dafoxia authored and mkrautz committed Jan 19, 2015
    Configuration menu
    Copy the full SHA
    2bb8bf8 View commit details
    Browse the repository at this point in the history

Commits on Mar 14, 2015

  1. Fix connection setup graphic.

    Graphic indicated crypt setup would be sent before client authenticated.
    hacst committed Mar 14, 2015
    Configuration menu
    Copy the full SHA
    f7d8789 View commit details
    Browse the repository at this point in the history

Commits on Mar 28, 2015

  1. Update protobuf link

    Protobuf project moved to github.
    bendem committed Mar 28, 2015
    Configuration menu
    Copy the full SHA
    4569ec0 View commit details
    Browse the repository at this point in the history
  2. Merge pull request #2 from bendem/patch-1

    Update protobuf link
    hacst committed Mar 28, 2015
    Configuration menu
    Copy the full SHA
    194a25c View commit details
    Browse the repository at this point in the history

Commits on May 3, 2015

  1. Voice data documentation

    - 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.
    Rantanen committed May 3, 2015
    Configuration menu
    Copy the full SHA
    c347f50 View commit details
    Browse the repository at this point in the history
  2. 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
    Rantanen committed May 3, 2015
    Configuration menu
    Copy the full SHA
    b485ab1 View commit details
    Browse the repository at this point in the history
  3. Cleaned index

    Rantanen committed May 3, 2015
    Configuration menu
    Copy the full SHA
    9954b29 View commit details
    Browse the repository at this point in the history
  4. Updated introduction

    Fixed the link to point to the current documentation and updated the
    Mumble version number.
    Rantanen committed May 3, 2015
    Configuration menu
    Copy the full SHA
    ea764aa View commit details
    Browse the repository at this point in the history
  5. Merge pull request #3 from Rantanen/master

    Voice Data & random tweaks
    hacst committed May 3, 2015
    Configuration menu
    Copy the full SHA
    a01b4f2 View commit details
    Browse the repository at this point in the history

Commits on Jan 6, 2022

  1. Fix use of pronouns

    * Use it/its for the "client" to be consistent with the rest of the docs
    * Use neutral pronouns (they/them) for user/speaker
    nyancrimew committed Jan 6, 2022
    Configuration menu
    Copy the full SHA
    ca56cf3 View commit details
    Browse the repository at this point in the history
  2. Merge pull request #4 from deletescape/pronoun-fix

    Fix use of pronouns
    Krzmbrzl authored Jan 6, 2022
    Configuration menu
    Copy the full SHA
    7c3435d View commit details
    Browse the repository at this point in the history

Commits on Nov 13, 2022

  1. Fix typo

    llunacb committed Nov 13, 2022
    Configuration menu
    Copy the full SHA
    1e3d3b5 View commit details
    Browse the repository at this point in the history
  2. Merge PR #5: Fix typo

    Krzmbrzl authored Nov 13, 2022
    Configuration menu
    Copy the full SHA
    b0d1421 View commit details
    Browse the repository at this point in the history

Commits on Nov 3, 2024

  1. 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
    Kissaki committed Nov 3, 2024
    Configuration menu
    Copy the full SHA
    d05262a View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    208dbc1 View commit details
    Browse the repository at this point in the history
  3. 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.
    Kissaki committed Nov 3, 2024
    Configuration menu
    Copy the full SHA
    b39bbf2 View commit details
    Browse the repository at this point in the history
  4. 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.
    Kissaki committed Nov 3, 2024
    Configuration menu
    Copy the full SHA
    eae0eac View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    be8874f View commit details
    Browse the repository at this point in the history