feat(ADR-0046): lightweight chrome (DocShell) for the docs routes#1690
Merged
Conversation
The /docs portal and /docs/:name viewer are app-independent top-level routes, so they rendered bare (no header, no way back) — looked unfinished. Add a minimal sticky DocShell header shared by both: a "Documentation" home link (→ /docs) plus a breadcrumb of the current doc. No app sidebar (keeps ADR-0046's "no nav taxonomy in v1"), just orientation + a way out. The portal's redundant in-body "Documentation" title is dropped in favour of the header. Verified live: portal shows header + grouped list; doc page shows "Documentation / <doc>" breadcrumb + typography-styled body; header back-link returns to the portal. No console 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. |
Contributor
✅ Console Performance Budget
📦 Bundle Size Report
Size Limits
|
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.
Why
The
/docsportal and/docs/<name>viewer are app-independent top-level routes, so they rendered as bare full-bleed pages — no header, no breadcrumb, no way back. After the typography fix (#1687) the content looks right, but the page still felt unfinished/floating.Change
A minimal, shared
DocShellsticky header used by both pages:/docsNo app sidebar — that keeps ADR-0046's stated "no navigation taxonomy in v1" intent. This is just orientation + a way out. The portal's redundant in-body
Documentationtitle is dropped in favour of the header.Verification (live, browser)
Ran the console against a docs-serving backend and exercised both routes:
/docs: sticky header +SHOWCASEgroup listingDocumentation Guide/Showcasewith machine names./docs/showcase_index: header breadcrumbDocumentation / Showcase, then the typography-styled body (h1 30px, spaced paragraphs, chip inline-code, themed links).Screenshots of both states captured during verification.
Stack
Builds on #1687 (typography). Together: docs now render styled and have basic chrome.
🤖 Generated with Claude Code