Skip to content

Conversation

@kylegach
Copy link
Contributor

@kylegach kylegach commented Aug 5, 2025

What I did

Corresponds with #32196

Checklist for Contributors

Testing

Manual testing

  1. Confirm the updated link is correct

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.

Greptile Summary

This PR fixes a broken internal link in the Storybook migration guide documentation. The change updates a relative path from ../configure/upgrading.mdx to ./upgrading.mdx on line 59 of the migration guide file. This addresses a 404 error that was occurring after documentation restructuring where migration guides were moved under the /docs/releases/ path.

The fix is straightforward - it corrects the link reference to point to the upgrading documentation within the same releases directory instead of trying to navigate to a non-existent configure directory. This ensures users can successfully access upgrade instructions when following links from the migration guide. The change aligns with Storybook's documentation structure and maintains the user experience by providing working navigation between related documentation pages.

Confidence score: 5/5

  • This PR is extremely safe to merge with no risk of breaking functionality
  • Score reflects a simple documentation link fix with clear intent and minimal complexity
  • No files require special attention as this is a single-line documentation correction

Context used:

Context - In the documentation, ensure that the links to the builder's documentation and the Next.js framework documentation are correct and not broken. (link)

@kylegach kylegach self-assigned this Aug 5, 2025
@kylegach kylegach requested a review from jonniebigodes as a code owner August 5, 2025 17:38
@kylegach kylegach 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 Aug 5, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

@nx-cloud
Copy link

nx-cloud bot commented Aug 5, 2025

View your CI Pipeline Execution ↗ for commit 022ad9e

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

☁️ Nx Cloud last updated this comment at 2025-08-05 20:17:55 UTC

@kylegach kylegach merged commit 8c8bdc5 into next Aug 5, 2025
8 checks passed
@kylegach kylegach deleted the docs-bad-upgrading-link branch August 5, 2025 21:32
yannbf pushed a commit that referenced this pull request Aug 11, 2025
Docs: Fix broken link in migration guide
(cherry picked from commit 8c8bdc5)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Aug 11, 2025
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants