docs: tabbed sidebar nav + de-emphasize objectql/ui/os protocol branding#1917
Merged
Conversation
Splits the single long docs sidebar into six icon-labelled tabs via fumadocs folder roots (Getting Started, Concepts, Guides, Reference, Protocol, Releases), so readers see one section at a time instead of all 366 pages competing in one rail. - root + icon on each top-level section meta.json; root meta.json reordered so Protocol (the early-emphasis ObjectQL/ObjectUI/ObjectOS layer) sits last and the generated Reference gets its own tab instead of crowding the hand-written docs. - references/meta.json is generated, so the Reference tab's title/icon/root is emitted from packages/spec/scripts/build-docs.ts (title "Protocol Reference" → "Reference"). - Guides regrouped: added a "Foundations" label, moved Service Contracts into Integration, surfaced Cheatsheets under their own label instead of buried after a bare divider. - Renamed colliding "Protocol" labels: "Protocol Overview" → "Protocol", "Contracts Protocol" → "Service Contracts". - Fixed the top-nav GitHub link target: objectstack-ai/spec → framework. Nav-only: no files moved, no doc URLs changed. `next build` compiles all 1113 pages clean; lucide icons resolve with no warnings. 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
documentation
Contributor
📓 Docs Drift CheckThis PR changes 1 package(s): 89 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:
|
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
1 participant
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.
Reworks the docs site left navigation for reader experience. The whole sidebar was one long rail mixing all 9 top-level groups + the 238 generated reference pages; this splits it into six icon-labelled tabs (fumadocs folder roots) so a reader sees one section at a time.
Changes (nav-only — no files moved, no doc URLs changed)
root: true+ lucideiconon each top-level section'smeta.json.references/meta.jsonis emitted bypackages/spec/scripts/build-docs.ts, so the title/icon/root were set there (titleProtocol Reference→Reference), not by hand-editing the generated file.Foundationslabel, moved Service Contracts intoIntegration, surfacedCheatsheetsunder their own label (was buried after a bare divider).Protocol Overview→Protocol,Contracts Protocol→Service Contracts.objectstack-ai/spec; nowframework.Verification
pnpm --filter @objectstack/docs build→ compiles all 1113 pages clean, no lucide "unknown icon" warnings.meta.json+layout.shared.tsx+ the generator. No reference content drift.Deferred (needs content decisions, not in this PR): three duplicate "Architecture" pages, glossary vs terminology overlap, and semantic renames of the 14 Reference categories.
🤖 Generated with Claude Code