Improve documentation discoverability and cross-linking#5739
Merged
Conversation
The CLAUDE.md entry point mentioned docs/arch/ only as inline text near the bottom, so the architecture documentation was easy for a reader (or agent) to miss. Add a prominent, clickable pointer to the architecture index at the top, and make AGENTS.md a symlink to CLAUDE.md so tools that read the AGENTS.md convention get the same canonical guidance. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The numbered architecture docs linked up to the index but rarely to each other, so moving between closely related topics (deployment modes and groups, runconfig and registry, transport and operator) meant routing back through the index. Add the missing lateral 'Related Documentation' links between strongly related docs, and give 14-plugins-system.md the Related section it was missing. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Several READMEs were not linked from any hub, so a reader browsing the docs could not discover them: the generated CLI reference, the server API docs, the e2e test guide, the local Keycloak and OpenTelemetry setups, and the Helm chart docs. Link each from the most relevant guide, and add a Contributing section to the chart README templates so their CONTRIBUTING guides are reachable. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5739 +/- ##
==========================================
+ Coverage 70.74% 70.78% +0.04%
==========================================
Files 683 683
Lines 69194 69194
==========================================
+ Hits 48950 48982 +32
+ Misses 16663 16616 -47
- Partials 3581 3596 +15 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
jhrozek
approved these changes
Jul 8, 2026
ChrisJBurns
approved these changes
Jul 8, 2026
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
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.
Summary
Our documentation was well written but hard to navigate: the architecture
docs — the richest knowledge in the repo — were only reachable through
passing inline-text mentions, several READMEs were not linked from any hub
(so a reader browsing the docs could not discover them), and the numbered
architecture documents rarely linked to each other. This makes it harder for
both new contributors and AI coding assistants to move from an entry point to
the document they need.
This PR improves discoverability and cross-linking without changing any doc
content:
CLAUDE.mdnow opens with a prominent,clickable pointer to the architecture index and a suggested reading order.
AGENTS.mdis added as a symlink toCLAUDE.mdso tools that follow theAGENTS.mdconvention get the same canonical guidance (one source of truth,no drift).
server API docs, the e2e test guide, and the local Keycloak and
OpenTelemetry setups from the most relevant developer guide. Add a
Contributing section to the Helm chart README templates so their
CONTRIBUTING guides are reachable (regenerated via
helm-docs).Documentation" links between strongly related documents (deployment modes ↔
groups, runconfig ↔ registry, transport ↔ operator, skills ↔ plugins), and
give
14-plugins-system.mdthe Related section it was missing.Type of change
Test plan
Verified that every relative link added or changed resolves to an existing
file. The two Helm chart
README.mdfiles are generated — I edited theREADME.md.gotmpltemplates and regenerated withhelm-docs, so thegenerated output stays in sync (diff is limited to the new Contributing
section).
Does this introduce a user-facing change?
No. Documentation navigation only; no doc content or product behavior changes.
Special notes for reviewers
AGENTS.mdis intentionally a symlink toCLAUDE.mdrather than a separatefile, to avoid two agent-instruction files drifting apart.
README.mdchanges are generated output; the source of truthis the
README.md.gotmplchange in the same commit.