Skip to content

Improve Components documentation discovery and correctness - #258

Merged
woksin merged 14 commits into
mainfrom
chore/improve-documentation-authoring
Sep 10, 2026
Merged

Improve Components documentation discovery and correctness#258
woksin merged 14 commits into
mainfrom
chore/improve-documentation-authoring

Conversation

@woksin

@woksin woksin commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Improve Components documentation discovery, correctness, troubleshooting, and reference coverage while adding Starlight authoring safeguards.

Added

  • Add ActionMenubar reference documentation and symptom-based troubleshooting.
  • Validate MDX usage, Starlight asides, route landings, and local links before merge.

Changed

  • Add metadata to component landings and improve recipe, tutorial, filtering, and component-selection paths.
  • Refocus Storybook documentation on browsing components and current assurance boundaries.

Fixed

  • Correct the CommandStepper and StepperCommandDialog relationship and public callback guidance.
  • Remove ineffective navigation metadata and leaked tool-call tags from documentation lint configuration.

Run Markdown, MDX, authoring, and local-link checks through one shared entry point so local and CI verification stay aligned.
Give Starlight explicit titles and descriptions while leaving navigation order to the table of contents. Preserve decision badges and normalize Markdown endings.
- State that both components execute the command
- Remove onSubmit from CommandStepper (not in CommandForm props)
- Document inherited onSuccess, onValidationFailure, onFailed only
- Clarify no outer dialog means no dialogPt/dialogUnstyled
- Note dialog owns cancel, busy state, and authorization routing
- Link ActionMenubar reference from Toolbar page-action-row note
- Add troubleshooting link from renderers index
- Add troubleshooting link from Styling index
- Promote troubleshooting in getting-started next steps
- Replace vague reference endings with concrete component links
- Remove 'reference' label and trailing periods from Next sections
- Add Tutorial as first Start-here card on root index
- Add tutorial next-step link in getting-started Recap
- Change 'non-modal command wizard' to 'inline command wizard' for CommandStepper
- Reduce Storybook body to brief browse orientation
- Remove hardcoded counts and issue link
- Correct Plain as conformance fixture, not adapter workspace
- Add Storybook release-gate bullet to ui-foundation without counts
- Add filtering decision-guide link from FilterPanel description
- Required by reviewed deep content plan task 5
@woksin woksin added the no-release Merging publishes no package, image, release, or deployment label Sep 10, 2026
@woksin
woksin merged commit ebf1c2d into main Sep 10, 2026
6 of 7 checks passed
@woksin
woksin deleted the chore/improve-documentation-authoring branch September 10, 2026 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-release Merging publishes no package, image, release, or deployment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant