From 4a1809e18f0ee9196b6e836ef4647a2c9a273db5 Mon Sep 17 00:00:00 2001 From: jrd Date: Fri, 17 Jul 2026 21:34:05 +0000 Subject: [PATCH 1/3] docs/README.md: index the documentation in this repository 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 --- docs/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/README.md b/docs/README.md index 3ac4a1f554..11b06bf100 100644 --- a/docs/README.md +++ b/docs/README.md @@ -46,6 +46,14 @@ along with this program. If not, see [](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 +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). + ## Project related documentation 1. Release process: https://jamulus.io/contribute/Release-Process From 33da8204978432edff9fcd93a8d2c10ddace753f Mon Sep 17 00:00:00 2001 From: jrd Date: Fri, 17 Jul 2026 22:20:09 +0000 Subject: [PATCH 2/3] Remove root-level docs links per review Co-Authored-By: Claude Fable 5 --- docs/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 11b06bf100..5f6c5c87a8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -52,8 +52,6 @@ Mostly documentation can be found on the Jamulus Website: https://jamulus.io 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). - ## Project related documentation 1. Release process: https://jamulus.io/contribute/Release-Process From 539854b5f07f192ba5d327183f9c308e80243ad1 Mon Sep 17 00:00:00 2001 From: jrd Date: Wed, 22 Jul 2026 18:49:23 +0000 Subject: [PATCH 3/3] docs/README.md: apply review feedback (capitalization, protocol clause) Addresses ann0see's suggested wording for the JAMULUS_PROTOCOL.md entry and pljones's note to capitalize Client/Server/Directory per the style guide, since they denote Jamulus-specific roles here. Co-Authored-By: Claude Sonnet 5 --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 5f6c5c87a8..749e092081 100644 --- a/docs/README.md +++ b/docs/README.md @@ -48,7 +48,7 @@ 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 +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