Commit Graph

14 Commits

Author SHA1 Message Date
Jan Klass
4c16d55df6 DOCS(dev): Convert file links 2025-01-26 13:54:24 +01:00
Jan Klass
e844cefec6 DOCS(dev): Drop underline escape 2025-01-26 13:54:24 +01:00
Jan Klass
94246a1345 DOCS(dev): Convert tables to code blocks 2025-01-26 13:54:23 +01:00
Jan Klass
809b7af0ca DOCS(dev): Convert footnotes 2025-01-26 13:54:23 +01:00
Jan Klass
69bec3274d DOCS(dev): Convert image refs 2025-01-26 13:24:58 +01:00
Jan Klass
24d71a3cc6 DOCS(dev): Convert headlines 2025-01-26 13:24:57 +01:00
Jan Klass
989329292f DOCS(dev): Rename rst files to md
This is done as a separate commit to retain Git change file history association. (Git does not store renames. It assumes renames according to content similarity.)
2025-01-26 13:24:57 +01:00
Jan Klass
5992aa3765 DOCS(dev): Drop broken, unnecessary fig ref
The figure follows below the paragraph.
2025-01-26 13:24:35 +01:00
Jan Klass
2aaae8c375 DOCS(dev): Fix UTP to TCP ref
The cross-document reference apparently worked on readthedocs (our previous docs), but does not work on GitHub.

The cross-document figure reference is replaced with a file reference.
2025-01-26 12:52:53 +01:00
Jan Klass
d1fc0334f4 DOCS(dev): Replace nbsp with normal spaces 2025-01-26 11:23:28 +01:00
Jan Klass
be8874f123 DOCS(protocol): Add file references to README.rst 2024-11-03 18:21:44 +01:00
Jan Klass
eae0eac75e 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.
2024-11-03 17:58:34 +01:00
Jan Klass
b39bbf2dec 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.
2024-11-03 17:54:24 +01:00
Jan Klass
d05262a9ce 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: 65462b4c3b
git-subtree-split: b0d142143c
2024-11-03 17:32:48 +01:00