Docs: Deprecate ExternalDocs#35074
Conversation
There was a problem hiding this comment.
Pull request overview
This PR deprecates the ExternalDocs and ExternalDocsContainer blocks from @storybook/addon-docs, surfacing runtime deprecation warnings and documenting the change in the migration guide.
Changes:
- Added a new migration entry describing the deprecation and planned removal in Storybook 11.
- Emitted deprecation warnings when
ExternalDocsandExternalDocsContainerare rendered. - Aligned the MIGRATION table-of-contents entry text for the TanStack Router migration section.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| MIGRATION.md | Adds a 10.4.0 → 10.5.0 migration note and TOC entries for the ExternalDocs deprecation. |
| code/addons/docs/src/blocks/blocks/external/ExternalDocsContainer.tsx | Logs a deprecation warning when ExternalDocsContainer is used. |
| code/addons/docs/src/blocks/blocks/external/ExternalDocs.tsx | Logs a deprecation warning when ExternalDocs is used. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR deprecates ChangesExternalDocs and ExternalDocsContainer Deprecation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes ✨ Finishing Touches📝 Generate docstrings
Comment |
What I did
Deprecated ExternalDocs, as per internal team discussions.
Checklist for Contributors
Manual testing
workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>`_
Summary by CodeRabbit
Deprecations
Documentation