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

Docs: Fix typo in generated button story #28559

Merged
merged 3 commits into from
Jul 12, 2024

Conversation

kyletsang
Copy link
Contributor

What I did

Fixes a minor typo in the generated example when bootstrapping a story

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

None necessary as it modifies a comment in the template

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

  • Fixed a minor typo in docs/_snippets/button-story-baseline.md comments
  • Improved clarity of comments in the button story template

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Jul 11, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 7608c30. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@jonniebigodes jonniebigodes self-assigned this Jul 12, 2024
@jonniebigodes jonniebigodes changed the title chore: fix typo in generated button story Docs: Fix typo in generated button story Jul 12, 2024
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Jul 12, 2024
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@kyletsang, thank you for putting together this pull request and helping us improve the documentation by catching this small typo in the example. We appreciate it 🙏 !

I've checked and all is good on my end and will gladly merge this once the checklist clears.

Hope you have a fantastic day.

Stay safe

@jonniebigodes jonniebigodes added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jul 12, 2024
@shilman shilman merged commit 80aa413 into storybookjs:next Jul 12, 2024
8 checks passed
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Docs: Fix typo in generated button story
(cherry picked from commit 80aa413)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Docs: Fix typo in generated button story
(cherry picked from commit 80aa413)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Docs: Fix typo in generated button story
(cherry picked from commit 80aa413)
@kyletsang kyletsang deleted the fix-button-story-typo branch July 12, 2024 18:17
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Docs: Fix typo in generated button story
(cherry picked from commit 80aa413)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Docs: Fix typo in generated button story
(cherry picked from commit 80aa413)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Docs: Fix typo in generated button story
(cherry picked from commit 80aa413)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Docs: Fix typo in generated button story
(cherry picked from commit 80aa413)
storybook-bot pushed a commit that referenced this pull request Jul 13, 2024
Docs: Fix typo in generated button story
(cherry picked from commit 80aa413)
storybook-bot pushed a commit that referenced this pull request Jul 15, 2024
Docs: Fix typo in generated button story
(cherry picked from commit 80aa413)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants