Docs: Update addon migration guide for 10.0 #32714
Conversation
📝 WalkthroughWalkthroughRetargets the addon migration guide to Storybook 10.0: updates titles, sidebar labels, links, section names, examples, and guidance; replaces 9.x-specific content with 10.0 conventions (ESM-only builds, CSF Next/4, removal of Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes ✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used📓 Path-based instructions (1)docs/**📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Files:
🪛 LanguageTooldocs/addons/addon-migration-guide.mdx[grammar] ~8-~8: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~8-~8: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~56-~56: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~60-~60: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [style] ~65-~65: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_NEED_TO_VB) [style] ~66-~66: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_NEED_TO_VB) [grammar] ~252-~252: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~252-~252: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~298-~298: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [grammar] ~341-~341: Ensure spelling is correct (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). (2)
🔇 Additional comments (4)
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: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/addons/addon-migration-guide.mdx(2 hunks)
⏰ 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). (2)
- GitHub Check: Danger JS
- GitHub Check: Core Unit Tests, windows-latest
|
View your CI Pipeline Execution ↗ for commit 0f59035
☁️ Nx Cloud last updated this comment at |
Sidnioulz
force-pushed
the
sidnioulz/addon-migration-guide-10
branch
from
98096b2 to
13a1bea
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/addons/addon-migration-guide.mdx (2)
16-16: Fix “toif” typo.Please change “toif” to “if” so the sentence reads correctly.
60-60: Switch addon-kit link to a stable branch.This still points at the temporary
addon-kit/blob/esm-only/tsup.config.ts, which will 404 after that branch is deleted. Update it tomain(or a tag/commit) before shipping so the docs don’t break.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/addons/addon-migration-guide.mdx(2 hunks)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 5
♻️ Duplicate comments (1)
docs/addons/addon-migration-guide.mdx (1)
60-61: Avoid linking to a transient feature branch; switch to a stable ref.
addon-kit/blob/esm-only/tsup.config.tswill 404 after merge. Point tomain(or a tag/commit) before publishing the guide.Apply:
-.../addon-kit/blob/esm-only/tsup.config.ts +.../addon-kit/blob/main/tsup.config.ts
🧹 Nitpick comments (1)
docs/addons/addon-migration-guide.mdx (1)
247-248: Consider re-exporting default as well (defensive).If
dist/preset.jsever has a default export,export *won’t re-export it. Optional but future‑proof:export * from './dist/preset.js'; +export { default } from './dist/preset.js';
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/addons/addon-migration-guide.mdx(2 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/addon-migration-guide.mdx
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/addons/addon-migration-guide.mdx (2)
60-60: Switch addon-kit link to a stable ref before publishing.Replace the transient
esm-onlybranch withmain(or a tag/commit) to avoid a future 404.
352-352: Verify MIGRATION.md anchor resolves before merge.Ensure the section exists and the slug matches.
Run this script to confirm the header exists and infer the slug:
#!/bin/bash set -euo pipefail # Look for a "From version 9.x to 10.0.0" header in MIGRATION.md on this branch fd -a MIGRATION.md | xargs -I{} rg -n '^#{1,6}\s*From version 9\.x to 10\.0\.0\b' -n -C1 {} || { echo "Header not found in MIGRATION.md on this branch." exit 1 } echo "Header found. GitHub slug should be: from-version-9x-to-1000"
🧹 Nitpick comments (2)
docs/addons/addon-migration-guide.mdx (2)
240-248: Add a note to set package.json to ESM.Since preset.js becomes ESM, remind users to set
"type": "module"in package.json to avoid loader mismatches.
273-276: Confirm addons path resolution with import.meta.resolve.import.meta.resolve returns a file URL. Verify Storybook’s addons array accepts the URL directly in all environments; otherwise wrap with fileURLToPath for consistency.
Example:
- addons: ["@storybook/addon-docs", import.meta.resolve("./local-preset.ts")], + import { fileURLToPath } from "node:url"; + addons: ["@storybook/addon-docs", fileURLToPath(import.meta.resolve("./local-preset.ts"))],
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/addons/addon-migration-guide.mdx(2 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/addon-migration-guide.mdx
⏰ 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
kylegach
left a comment
kylegach
left a comment
There was a problem hiding this comment.
Great work, @Sidnioulz! Left a few requested changes, but I'm approving to unblock.
Thanks for the review 🙇 |
Sidnioulz
force-pushed
the
sidnioulz/addon-migration-guide-10
branch
from
140b1d6 to
0f59035
Compare
TODOS
-apirecos with Jeppeaddon-kitPR: Add manager-helpers example addon-kit#86Adjust; added note on the addon-kit PRaddon-kittsup config URL fromesm-onlytomainonceaddon-kitPR is mergedWhat I did
Updated addon migration guide for SB10.
Checklist for Contributors
Testing
Manual testing
Port an addon with this guide 😉
Documentation
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