Docs: Fix up references to old storybook-addons keyword #32797
Conversation
Sidnioulz
added
documentation
ci:docs
📝 WalkthroughWalkthroughThe pull request updates addon documentation to standardize the required keyword from "storybook-addons" (plural) to "storybook-addon" (singular) in integration catalog metadata guidance and addon writing examples. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/addons/integration-catalog.mdx (1)
27-27: Improve the clarity of the guidance text.The phrasing "You must add the
storybook-addonas the first keyword" reads awkwardly with the article "the" before the code element. Consider removing it for better clarity.-We rely on metadata to organize your addon in the catalog. You must add the <code>storybook-addon</code> as the first keyword, followed by your addon's category. Additional keywords will be used in search and as tags. +We rely on metadata to organize your addon in the catalog. You must add <code>storybook-addon</code> as the first keyword, followed by your addon's category. Additional keywords will be used in search and as tags.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/addons/integration-catalog.mdx(2 hunks)docs/addons/writing-addons.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Update documentation under
docs/for significant changes, including migration guides for breaking changes
Files:
docs/addons/writing-addons.mdxdocs/addons/integration-catalog.mdx
🪛 LanguageTool
docs/addons/integration-catalog.mdx
[grammar] ~27-~27: Ensure spelling is correct
Context: ...a We rely on metadata to organize your addon in the catalog. You must add the ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (4)
docs/addons/integration-catalog.mdx (2)
34-34: Keyword standardization in metadata example looks good.
The keywords example correctly reflects the new singular storybook-addon keyword requirement. This aligns with the catalog metadata guidance and will help users follow the correct convention.
72-72: Package.json example correctly updated.
The example now properly demonstrates the use of the singular storybook-addon keyword, ensuring users copying this example will follow the new standard from the start.
docs/addons/writing-addons.mdx (2)
218-218: Keywords example correctly standardized.
The Integration Catalog Metadata example now shows the singular storybook-addon keyword, ensuring consistency with the integration-catalog.mdx guidance. Developers using this as a reference will implement the correct keyword format.
226-226: Explanatory text correctly references the singular keyword.
The updated guidance properly explains the role of the storybook-addon keyword in catalog discoverability, helping developers understand why this standardized keyword is important.
jonniebigodes
left a comment
jonniebigodes
left a comment
There was a problem hiding this comment.
@Sidnioulz thanks for taking the time to put together this pull request and adjust the documentation. Appreciate it 🙏 !
I've checked, and everything is good on my end.
I'll get this once the addon kit pr is merged. Sounds good?
Have a great day.
Stay safe
|
View your CI Pipeline Execution ↗ for commit 5fd5036
☁️ Nx Cloud last updated this comment at |
shilman
added
the
patch:yes
Sounds like a plan, cheers! |
…eywords Docs: Fix up references to old storybook-addons keyword (cherry picked from commit 03f6307)
github-actions
bot
added
the
patch:done
ndelangen
removed
the
patch:yes
What I did
Renamed
storybook-addonswhere needed to accompany changes toaddon-kiton storybookjs/addon-kit#85Checklist for Contributors
Testing
N/A
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>Summary by CodeRabbit