docs/README.md: index the documentation in this repository#3796
Open
mcfnord wants to merge 2 commits into
Open
docs/README.md: index the documentation in this repository#3796mcfnord wants to merge 2 commits into
mcfnord wants to merge 2 commits into
Conversation
The README linked only to website docs; now it also lists what is in docs/ itself and the related root-level docs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ann0see
requested changes
Jul 17, 2026
| 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 | ||
|
|
||
| Related, at the repository root: [COMPILING.md](../COMPILING.md), [CONTRIBUTING.md](../CONTRIBUTING.md), [SECURITY.md](../SECURITY.md). |
Member
There was a problem hiding this comment.
Remove this. I expect humans and agents to be smart enough to find those.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
Author
|
Done — removed. |
ann0see
reviewed
Jul 17, 2026
|
|
||
| ## In this directory | ||
|
|
||
| 1. [JAMULUS_PROTOCOL.md](JAMULUS_PROTOCOL.md): how clients, servers and directories talk to each other |
Member
There was a problem hiding this comment.
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 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
One file. docs/README.md linked only to website documentation; it now also lists the three docs that live in this directory (with a warning that JSON-RPC.md is generated) and the related root-level docs. Links only to files that exist on main today.
CHANGELOG: SKIP
🤖 Generated with Claude Code