Skip to content
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.

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

Shortcut: Add Storybook stories #53627

Merged
merged 3 commits into from
Aug 24, 2023

Conversation

bangank36
Copy link
Contributor

@bangank36 bangank36 commented Aug 14, 2023

What?

Why?

Missing stories for components has been discussed on #36128 (comment)

How?

  • Add new /stories folder on /shortcut
  • Remove @example syntax on the noted components
  • About Text component: its stories and type migration should be addressed on followed-up PRs

Testing Instructions

  • Checkout this branch
  • Run npm run storybook:dev
    1. Confirm the shortcut stories at ?path=/docs/components-shortcut--docs is working
    2. Confirm these stories has the correct JSDoc on storybook

Testing Instructions for Keyboard

Screenshots or screencast

image

@bangank36 bangank36 marked this pull request as ready for review August 14, 2023 10:04
@mirka mirka self-requested a review August 15, 2023 19:05
@mirka mirka added [Type] Developer Documentation Documentation for developers Storybook Storybook and its stories for components labels Aug 15, 2023
Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks for the @example cleanup too.

packages/components/src/shortcut/stories/index.story.tsx Outdated Show resolved Hide resolved
packages/components/CHANGELOG.md Outdated Show resolved Hide resolved
* Provide stories for the Shortcut component

* Remove @example syntax for Storybook to parse JSDoc correctly

Update packages/components/src/shortcut/stories/index.story.tsx

Expand source tab by default in Storybook V7

Co-authored-by: Lena Morita <[email protected]>

Cleanup ChangeLog
Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thank you!

@mirka mirka enabled auto-merge (squash) August 24, 2023 18:40
@mirka mirka merged commit 9a2f2cc into WordPress:trunk Aug 24, 2023
48 checks passed
@github-actions github-actions bot added this to the Gutenberg 16.6 milestone Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Storybook Storybook and its stories for components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants