Skip to content

docs(design): renumber sections and move ranui names into the adapter - #451

Merged
chaxus merged 1 commit into
mainfrom
docs/design-p0-cleanup
Oct 25, 2026
Merged

chaxus merged 1 commit into
mainfrom
docs/design-p0-cleanup

Conversation

@chaxus

@chaxus chaxus commented Oct 25, 2026

Copy link
Copy Markdown
Owner

Summary

P0 of the design-guidance improvement plan. The changes are docs only, with no runtime changes.

  • Continuous section numbers. The portable design/DESIGN.md now runs 1–10 with no gap: Composition goes from §11 to §9 and Information architecture from §12 to §10. All cross-references and anchors are updated: the interface guide, the en/cn design-guide pages, CODING, CLAUDE.md and CSS comments. Historical changelogs keep the old numbers on purpose.
  • Adapter headings "9. Components" and "10. Component token naming" are now unnumbered ranui headings, so they no longer clash with the portable numbers in the generated packages/ranui/docs/DESIGN.md.
  • No r-* names in the portable spec. The modal and tabs navigation rules are worded generically, and the ranui mapping lives in the adapter.
  • One spacing source. The adapter's 8/16/32–40px rhythm list is removed; it points to the existing spacing relationships table instead.
  • r-card reference in packages/ranui/CLAUDE.md uses heading instead of the stale title, lists hoverable, and describes header visibility the way _syncHeader() actually works.
  • Design skill. The approval sentence is clarified. The 2026-10-22 eval README now says the installed "1.2.0" was the then-separate ranui agent plugin, not the npm package.
  • The generated guides and plugin references are regenerated with sync:design and sync:agent-plugin.

Verification

  • pnpm verify:docs (includes the design sync check, the agent-plugin check and check:langs)
  • pnpm verify:links
  • pnpm -F ranui verify:design: 9 rules, no new violations (294 known)
  • pnpm -F ranui exec vitest run test/unit/docs.interface-guidance.test.ts: 9/9
  • Prettier check on the changed files
  • An independent review of the diff found no stale anchors or section references and no lost rule meaning.

🤖 Generated with Claude Code

- Number the portable DESIGN sections 1–10 without a gap and update
  every cross-reference and anchor.
- Unnumber the adapter's component headings so they no longer collide
  with the portable section numbers.
- Word the navigation-layer rules generically; the r-* mapping lives in
  the ranui adapter.
- Keep one spacing relationship table instead of a second rhythm list.
- Use `heading` (not the stale `title`) in the r-card reference and
  list `hoverable`.
- Clarify the design skill's approval sentence and that the 2026-10-22
  eval installed the `ranui` agent plugin 1.2.0, not the npm package.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying ran with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5511c75
Status: ✅  Deploy successful!
Preview URL: https://a75fc378.ran-4ty.pages.dev
Branch Preview URL: https://docs-design-p0-cleanup.ran-4ty.pages.dev

View logs

@chaxus
chaxus merged commit c88bd06 into main Oct 25, 2026
14 checks passed
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