Skip to content

docs: nightly quality fixes (2026-07-10)#47

Open
jamierthompson wants to merge 1 commit into
mainfrom
docs/nightly-quality-2026-07-10
Open

docs: nightly quality fixes (2026-07-10)#47
jamierthompson wants to merge 1 commit into
mainfrom
docs/nightly-quality-2026-07-10

Conversation

@jamierthompson

Copy link
Copy Markdown
Owner

What & why

Automated nightly documentation & code-quality sweep. One change:

  • src/demo/index.ts — trimmed an aspirational note in the barrel's doc comment: "the surface that will become the npm package" → dropped. The package is private: true with no publish config, so the clause was a speculative "will exist" reference (the kind that quietly goes stale). The accurate description ("Public API for the demo; consumers import from here, never internal paths") is kept, and the two sentences were merged for concision.

Everything else checked out — README/AGENTS claims match the code (stack, Radix Dialog/ScrollArea/Tabs usage, feature and testing-coverage claims), links resolve, and the code comments are load-bearing "why"/state descriptions (e.g. the legend pulse-replay gotcha, the state-machine test notes), so they were left as-is.

How tested

Docs/comment-only change; no runtime or contract impact. No behavior, control flow, public API, or config touched.

Rules or docs touched

None — comment-only edit in src/demo/index.ts.

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.

1 participant