Skip to content

docs/README.md: index the documentation in this repository #3796

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.

Sign up for GitHub

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

Open
mcfnord wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −0
Open

docs/README.md: index the documentation in this repository #3796

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a1809e
docs/README.md: index the documentation in this repository
Jul 17, 2026
33da820
Remove root-level docs links per review
Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ along with this program. If not, see [<https://www.gnu.org/licenses/>](https://

Mostly documentation can be found on the Jamulus Website: https://jamulus.io

## In this directory

1. [JAMULUS_PROTOCOL.md](JAMULUS_PROTOCOL.md): how clients, servers and directories talk to each other

@ann0see ann0see Jul 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. [JAMULUS_PROTOCOL.md](JAMULUS_PROTOCOL.md): how clients, servers and directories talk to each other
1. [JAMULUS_PROTOCOL.md](JAMULUS_PROTOCOL.md): how clients, servers and directories talk to each other using the Jamulus protocol

2. [JSON-RPC.md](JSON-RPC.md): the JSON-RPC API — generated by `tools/generate_json_rpc_docs.py`, do not edit by hand
3. [TRANSLATING.md](TRANSLATING.md): guide for translators

## Project related documentation

1. Release process: https://jamulus.io/contribute/Release-Process
Expand Down