Skip to content

Simplify component API guidance - #29

Merged
elithrar merged 1 commit into
mainfrom
codex/docs-simplification
Sep 1, 2026
Merged

elithrar merged 1 commit into
mainfrom
codex/docs-simplification

Conversation

@elithrar

@elithrar elithrar commented Sep 1, 2026

Copy link
Copy Markdown
Owner

Summary

  • replace dense guidance paragraphs with 2–3 short, decision-oriented bullets
  • emphasize defaults, component choices, and explicit overrides over implementation details
  • rename internal-sounding Window headings to user-facing API guidance
  • clarify that defaultAction visually designates the expected Enter action rather than handling keyboard submission

The copy follows the concise pattern used in the OpenAI and Vercel developer docs: brief purpose, pragmatic choice guidance, then the existing example or expandable code.

Validation

  • npm run check — 51 tests passed
  • npm run build
  • npm run build:docs
  • local npm run test:browser could not start because the Playwright Chromium download repeatedly timed out; PR CI should run the existing seven responsive browser checks

@elithrar
elithrar merged commit 25fb41e into main Sep 1, 2026
1 check passed
@elithrar
elithrar deleted the codex/docs-simplification branch September 1, 2026 19:36
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