docs: add Spinner, GlobalHeaderLayout and sidebar-layout body-slot pages - #542
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Salvages the usable half of the Documentation Updater's output in #541. That PR was generated against main before #515 landed, so 13 of its 23 files conflicted — in every one of those, #515's version is the better text: it uses the real prop (`<Layout gap={6}>` rather than `className="gap-6"`), semantic tokens (`bg-muted` rather than `bg-gray-50`), and keeps the styling-boundary prose the generated pass simply deleted. All 13 are resolved to main, so this commit carries none of them. What is left is the part with no counterpart on main: - `docs/components/spinner.md` — new page. Spinner ships in this release and had no documentation. Size table (12/14/16/20) and the decorative-unless-named aria behavior verified against SPINNER_SIZES and the component. - `docs/components/global-header-layout.md` — new page. All four common props, their defaults, the children/body mutual exclusivity and all six namespaced parts verified against global-header-layout.tsx. - `docs/components/sidebar-layout.md` — documents the `body` slot and `topBar`, neither of which main mentions at all. #515's styling boundary note was lost in the rewrite and is restored here. - `docs/components/default-sidebar.md`, `command-palette.md`, `use-page-meta.md` — brought in step with the shipped API. The palette page's "Custom Palette (Advanced)" section goes: it demonstrated `useCommandPalette` and `navItemsToRoutes`, neither of which is exported from index.ts, so the example could never have run. CLAUDE.md is untouched. The generated pass appended a nine-entry `### Documentation Index` beside the convention table added in #540 — the enumerated shape that rotted the last one — so that hunk is dropped. #541's remaining four files (table, timeline, tooltip, quickstart) fall out entirely: main already carries the same corrections. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
IzumiSy
approved these changes
Sep 17, 2026
Contributor
Code Metrics Report
Details | | main (7748583) | #542 (dcb1247) | +/- |
|---------------------|----------------|----------------|------|
| Coverage | 87.4% | 87.4% | 0.0% |
| Files | 204 | 204 | 0 |
| Lines | 6014 | 6014 | 0 |
| Covered | 5257 | 5257 | 0 |
+ | Test Execution Time | 1m56s | 1m47s | -9s |Reported by octocov |
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.
Salvages the usable half of the Documentation Updater's output in #541, which is conflicted against
mainand cannot be merged as-is.Why not just rebase #541
It was generated before #515 landed, so 13 of its 23 files conflict. I merged it locally to check what those conflicts actually are: every one is an
astw:removal that #515 already did better.main(#515)layout.md<Layout className="gap-6"><Layout gap={6}>— the real proplayout.mdclassName="bg-gray-50"className="bg-muted"— semantic tokenalert.mdResolving those 13 files by hand would land back exactly where
mainalready is. All 13 are resolved tomain, so none of them appear in this PR.Four more (
table,timeline,tooltip,quickstart) drop out entirely —mainalready carries the same corrections.What's actually here
Six files, all with no counterpart on
main:docs/components/spinner.md— new page.Spinnerships in this release with no docs at all. Size table (12/14/16/20) and the decorative-unless-named aria behavior verified againstSPINNER_SIZESand the component source.docs/components/global-header-layout.md— new page. All four common props and their defaults, thechildren/bodymutual exclusivity, and all six namespaced parts verified againstglobal-header-layout.tsx.docs/components/sidebar-layout.md— documents thebodyslot andtopBar.maindoes not mentionbodyanywhere. fix(core): correct astw: prefix order in shipped components, and the prefix advice in docs/ #515's styling-boundary note was lost in the generated rewrite and is restored here.docs/components/default-sidebar.md,command-palette.md,use-page-meta.md— brought in step with the shipped API.One deletion worth calling out: the palette page's "Custom Palette (Advanced)" section is gone. It demonstrated
useCommandPaletteandnavItemsToRoutes, neither of which is exported fromindex.ts— the example could never have compiled.CLAUDE.mdis untouched. The generated pass appended a nine-entry### Documentation Indexalongside the convention table from #540 — the enumerated shape that rotted the previous one — so that hunk is dropped.Why this is worth landing before the release
Merging the Version Packages PR (#524) deletes all 13 changesets, and the Documentation Updater reads
.changeset/*.mdas its only input, callingnoopwhen there are none. Once you publish, the automation can no longer document this release — anything missing has to be written by hand.Verification
pnpm fmt:check— clean, 640 filesastw:count acrossdocs/unchanged frommain(10 mentions, all correctly describing it as internal)Closes #541.
🤖 Generated with Claude Code