Skip to content

[6.x] Improve Storybook Docs #13383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
jasonvarga merged 34 commits into from
Dec 19, 2025
Merged

[6.x] Improve Storybook Docs #13383

jasonvarga merged 34 commits into from
Dec 19, 2025
+4,912 −265

Conversation

@duncanmcclean
Copy link
Member

@duncanmcclean duncanmcclean commented Dec 18, 2025 •
edited
Loading

This pull request makes a bunch of improvements to our Storybook docs site, used for documenting UI Components.

Changes:

  • Adds descriptions to most component props & events
    • Prop descriptions come from JSDoc documents next to the props themselves.
    • Event descriptions are defined on the individual stories.
  • Documents remaining components
  • Moves the "Overview" page from the main docs site
  • Splits components into multiple sections
  • Replaces the favicon
  • Added a few missing exports: ContextHeader and DataTable...

Known issues

  • Portals don't currently work in Storybook. This means modals, stacks and the code editor (which uses a portal for fullscreen mode) won't work properly right now.
  • The CreateForm examples currently error out. Still need to look into why.

@duncanmcclean duncanmcclean marked this pull request as draft December 18, 2025 20:12
duncanmcclean added a commit to statamic/docs that referenced this pull request Dec 18, 2025
@duncanmcclean
UI Component tweaks
69f7428 
- Removed dedicated "UI Components" section
- Added "UI Components" link under "Vue Components" section
- Updated redirects
- Updated Storybook searchable to handle upcoming changes to structure of Storybook docs
- Removed the UI Components Overview page, as it is being moved into Storybook.

Related: statamic/cms#13383
@duncanmcclean duncanmcclean marked this pull request as ready for review December 19, 2025 15:49
@jasonvarga jasonvarga merged commit 4be3c20 into master Dec 19, 2025
11 checks passed
@jasonvarga jasonvarga deleted the storybook-docs branch December 19, 2025 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@duncanmcclean @jasonvarga