docs(nav): group Protocol Reference modules and clarify top-level nav#1862
Merged
Conversation
The docs site rendered fine but its information architecture was hard to navigate: 238 of 366 pages live under Protocol Reference, and each module was a single flat alphabetical list (system: 40, api: 38, kernel: 32, …). The top-level "Protocol" (5 pages) vs "Protocol Reference" (238 pages) split was also ambiguous. Navigation-only changes (no content edits, no file moves): - Add second-level `---section---` groups to the 8 largest reference modules (system, api, kernel, data, ui, cloud, automation, ai), turning each flat list into labeled logical groups. Smaller modules (≤9 pages) stay flat to avoid over-fragmenting short lists. - Rename top-level "Protocol" → "Protocol Overview" to distinguish the conceptual intro from the per-module "Protocol Reference". - Remove the empty, orphaned references/contracts/ folder. Every regrouped meta.json was validated: valid JSON, every existing .mdx covered, no dangling entries. Verified in the browser (grouped section headers render correctly, no build errors). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
size/m
documentation
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.
Why
The docs site renders fine but the information architecture is hard to navigate. Of 366 doc pages, 238 live under Protocol Reference, and each module was a single flat alphabetical list (system: 40, api: 38, kernel: 32, data: 24, ui: 22 …). The top-level "Protocol" (5 pages) vs "Protocol Reference" (238 pages) split was also ambiguous.
What (navigation-only — no content edits, no file moves)
---section---groups added to the 8 largest reference modules —system,api,kernel,data,ui,cloud,automation,ai— turning each flat list into labeled logical groups (e.g. System → Runtime & Services / Observability / Metadata & Migration / Security & Compliance / Tenancy & Provisioning / Deployment & Operations / Communication & Localization). Modules with ≤9 pages stay flat to avoid over-fragmenting short lists.Protocol→Protocol Overviewto distinguish the conceptual intro from the per-moduleProtocol Reference.references/contracts/folder (pages: [], not referenced by the root meta).Verification
meta.json: valid JSON, every existing.mdxcovered, no dangling/misspelled entries.Because no files were moved, all URLs are unchanged. Truly collapsible folder sub-trees (vs. section-header separators) would require moving
.mdxinto subfolders + URL redirects — left as a possible follow-up.🤖 Generated with Claude Code