Skip to content

docs: add Spinner, GlobalHeaderLayout and sidebar-layout body-slot pages - #542

Merged
interacsean merged 2 commits into
mainfrom
docs/salvage-541-api-pages
Sep 17, 2026
Merged

interacsean merged 2 commits into
mainfrom
docs/salvage-541-api-pages

Conversation

@interacsean

Copy link
Copy Markdown
Contributor

Salvages the usable half of the Documentation Updater's output in #541, which is conflicted against main and 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.

File #541 main (#515)
layout.md <Layout className="gap-6"> <Layout gap={6}> — the real prop
layout.md className="bg-gray-50" className="bg-muted" — semantic token
alert.md deleted the explanation kept it, linked to the styling concept page

Resolving those 13 files by hand would land back exactly where main already is. All 13 are resolved to main, so none of them appear in this PR.

Four more (table, timeline, tooltip, quickstart) drop out entirely — main already carries the same corrections.

What's actually here

Six files, all with no counterpart on main:

  • docs/components/spinner.md — new page. Spinner ships in this release with no docs at all. Size table (12/14/16/20) and the decorative-unless-named aria behavior verified against SPINNER_SIZES and the component source.
  • docs/components/global-header-layout.md — new page. All four common props and 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. main does not mention body anywhere. 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 useCommandPalette and navItemsToRoutes, neither of which is exported from index.ts — the example could never have compiled.

CLAUDE.md is untouched. The generated pass appended a nine-entry ### Documentation Index alongside 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/*.md as its only input, calling noop when 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 files
  • Catalogue link script — 28 pages OK
  • All relative links in the six changed files resolve to existing targets
  • astw: count across docs/ unchanged from main (10 mentions, all correctly describing it as internal)

Closes #541.

🤖 Generated with Claude Code

github-actions Bot and others added 2 commits September 17, 2026 01:23
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>
@github-actions

Copy link
Copy Markdown
Contributor

Code Metrics Report

main (7748583) #542 (dcb1247) +/-
Coverage 87.4% 87.4% 0.0%
Test Execution Time 1m56s 1m47s -9s
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

@interacsean
interacsean merged commit 429271a into main Sep 17, 2026
6 checks passed
@interacsean
interacsean deleted the docs/salvage-541-api-pages branch September 17, 2026 05:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants