Skip to content

Docs: Deprecate ExternalDocs#35074

Merged
Sidnioulz merged 1 commit into
nextfrom
sidnioulz/deprecate-externaldocs
Jun 8, 2026
Merged

Docs: Deprecate ExternalDocs#35074
Sidnioulz merged 1 commit into
nextfrom
sidnioulz/deprecate-externaldocs

Conversation

@Sidnioulz

@Sidnioulz Sidnioulz commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

What I did

Deprecated ExternalDocs, as per internal team discussions.

Checklist for Contributors

Manual testing

  • Try to render ExternalDocs in a side project
  • Notice the deprecation warning
    workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>`_

Summary by CodeRabbit

  • Deprecations

    • ExternalDocs and ExternalDocsContainer components are now deprecated and scheduled for removal in Storybook 11.
  • Documentation

    • Updated migration guide with new section documenting the transition path for version 10.5.0.

@Sidnioulz Sidnioulz requested a review from shilman June 5, 2026 17:57
Copilot AI review requested due to automatic review settings June 5, 2026 17:57
@Sidnioulz Sidnioulz added maintenance User-facing maintenance tasks ci:normal Run our default set of CI jobs (choose this for most PRs). qa:skip Pull Requests that do not need any QA. labels Jun 5, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ExternalDocs and ExternalDocsContainer are 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.

@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: feca2227-54e3-475f-8ada-566a89a2b849

📥 Commits

Reviewing files that changed from the base of the PR and between 10386ac and 1195a1e.

📒 Files selected for processing (3)
  • MIGRATION.md
  • code/addons/docs/src/blocks/blocks/external/ExternalDocs.tsx
  • code/addons/docs/src/blocks/blocks/external/ExternalDocsContainer.tsx

📝 Walkthrough

Walkthrough

This PR deprecates ExternalDocs and ExternalDocsContainer components from the docs addon. Both components now emit runtime deprecation warnings via the deprecate utility. Migration documentation is added to guide users toward alternatives before removal in Storybook 11.

Changes

ExternalDocs and ExternalDocsContainer Deprecation

Layer / File(s) Summary
Runtime deprecation warnings in components
code/addons/docs/src/blocks/blocks/external/ExternalDocs.tsx, code/addons/docs/src/blocks/blocks/external/ExternalDocsContainer.tsx
ExternalDocs and ExternalDocsContainer import deprecate from the internal client logger and call it within their component bodies to emit deprecation notices indicating removal in Storybook 11.
Migration documentation
MIGRATION.md
The table of contents is updated with a new "10.4.0 to 10.5.0" section entry, and a new subsection explains that both components are deprecated, will be removed in Storybook 11, and requests users to open issues describing their use cases.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

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

@Sidnioulz Sidnioulz merged commit ce685da into next Jun 8, 2026
145 of 149 checks passed
@Sidnioulz Sidnioulz deleted the sidnioulz/deprecate-externaldocs branch June 8, 2026 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:normal Run our default set of CI jobs (choose this for most PRs). maintenance User-facing maintenance tasks qa:skip Pull Requests that do not need any QA.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants