Skip to content

Conversation

@yannbf
Copy link
Member

@yannbf yannbf commented Oct 28, 2025

Closes #

What I did

The link was pointing to a branch that is now outdated.

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-storybook/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 publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

  • Documentation
    • Updated addon migration guide reference link to point to the current documentation source.

@yannbf yannbf self-assigned this Oct 28, 2025
@yannbf yannbf added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Oct 28, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 28, 2025

📝 Walkthrough

Walkthrough

This pull request updates a hyperlink reference in the addon migration guide documentation. The link to addon-kit's tsup.config.ts configuration is changed from the esm-only branch to the main branch, reflecting the current source location.

Changes

Cohort / File(s) Change Summary
Documentation hyperlink update
docs/addons/addon-migration-guide.mdx
Updated addon-kit tsup.config.ts reference URL from esm-only branch to main branch

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single documentation file with a straightforward hyperlink correction
  • No logic changes or functional impact

Possibly related PRs

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch yann/update-addon-kit-docs

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e50eb0 and b3ec0ae.

📒 Files selected for processing (1)
  • docs/addons/addon-migration-guide.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/addon-migration-guide.mdx
🪛 LanguageTool
docs/addons/addon-migration-guide.mdx

[grammar] ~60-~60: Ensure spelling is correct
Context: ...-only builds Storybook 10 requires all addons to be built as ESM-only. This change si...

(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)
  • GitHub Check: Danger JS
  • GitHub Check: Core Unit Tests, windows-latest
🔇 Additional comments (1)
docs/addons/addon-migration-guide.mdx (1)

60-60: Link update aligns with PR objectives.

The URL change from the esm-only branch to the main branch correctly reflects the current source location of the addon-kit reference file, as intended by this PR.


Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link

nx-cloud bot commented Oct 28, 2025

View your CI Pipeline Execution ↗ for commit 6dc1b36

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 45s View ↗

☁️ Nx Cloud last updated this comment at 2025-10-28 18:30:10 UTC

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.

@yannbf thanks for catching this issue and adjusting the documentation. Appreciate it 🙏 !

This is good on my end.

If you don't mind, I'll merge this so that the documentation is updated as soon as possible.

@jonniebigodes jonniebigodes merged commit 8c504ca into next Oct 28, 2025
10 checks passed
@jonniebigodes jonniebigodes deleted the yann/update-addon-kit-docs branch October 28, 2025 20:29
ndelangen pushed a commit that referenced this pull request Oct 29, 2025
Docs: Update addon migration guide link
(cherry picked from commit 8c504ca)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Oct 29, 2025
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.

4 participants