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 Addon themes API documentation #29102

Merged
merged 2 commits into from
Sep 23, 2024

Conversation

kazuyainoue0124
Copy link
Contributor

@kazuyainoue0124 kazuyainoue0124 commented Sep 11, 2024

What I did

This is my first OSS contribution, so I apologize if there are any mistakes.
Fixed a typo in the code/addons/themes/docs/api.md docs page.
If there are no issues with this PR, I will fix similar typos in other pages as well.

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

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

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>

Greptile Summary

This PR fixes a minor typo in the Storybook addon-themes documentation, improving its accuracy.

  • Corrected the spelling of 'Vuetify' in a comment in code/addons/themes/docs/api.md
  • Changed 'withVeutifyTheme.decorator.js' to 'withVuetifyTheme.decorator.js'
  • This small correction enhances the clarity of the custom decorator example for Vuetify

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.

LGTM

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

@kazuyainoue0124
Copy link
Contributor Author

Danger task failing on branch due to a 403 on the GitHub user "Resource not accessible by integration".
"Could not add a commit status, the GitHub token for Danger does not have access rights."

What does this message mean?

@jonniebigodes jonniebigodes self-assigned this Sep 12, 2024
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Sep 23, 2024
@jonniebigodes jonniebigodes changed the title Docs: Fix typo in api.md Docs: Fix typo in Addon themes API documentation Sep 23, 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.

@kazuyainoue0124 thank you so much for taking the time to put together this pull request and helping us improve the documentation by catching this small typo. We appreciate it 🙏 ! All is good on my end, and I'll gladly merge this once the checklist clears.

The issue of danger will be looked into.

Looking forward to seeing your next contribution.

Have a fantastic week.

Stay safe.

Copy link

nx-cloud bot commented Sep 23, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9414c0d. 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 merged commit 48980f6 into storybookjs:next Sep 23, 2024
8 checks passed
@github-actions github-actions bot mentioned this pull request Sep 23, 2024
21 tasks
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants