Maintenance: Fix broken and outdated documentation links #29412
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 059df06. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
29 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile
kasperpeulen
added
ci:docs
There was a problem hiding this comment.
I fixed the underlying bug that was breaking a bunch of redirects. It's definitely better to have the canonical URLs being used everywhere, though, so this PR is still great.
The one exception is that some of the migration guide links pertain specifically to SB 8 features, so those should retain the version in the URL. I've left comments calling each of those out.
| prompt({}) { | ||
| return dedent` | ||
| You have features.legacyMdx1 in your Storybook main config file. This feature has been removed. Shall we remove it from your Storybook main config file? | ||
| Link: https://storybook.js.org/docs/8.0/migration-guide | ||
| Link: https://storybook.js.org/docs/migration-guide |
There was a problem hiding this comment.
FYI, I've fixed the bug that broke some redirects, including this one.
Proof: https://storybook.js.org/docs/8.0/migration-guide
Because this link is specific to the 7→8 migration guide, it's best that the version remains so that it points to the correct place when SB 9 is released.
| Link: https://storybook.js.org/docs/migration-guide | |
| Link: https://storybook.js.org/docs/8.0/migration-guide |
| @@ -108,7 +109,7 @@ export const viteConfigFile = { | |||
| If you already have these plugins, you can ignore this message. | |||
|
|
|||
| You can find more information on how to do this here: | |||
| https://storybook.js.org/docs/8.0/migration-guide/#missing-viteconfigjs-file | |||
| https://storybook.js.org/docs/migration-guide#missing-viteconfigjs-file | |||
There was a problem hiding this comment.
See prior comment
| https://storybook.js.org/docs/migration-guide#missing-viteconfigjs-file | |
| https://storybook.js.org/docs/8.0/migration-guide#missing-viteconfigjs-file |
| @@ -118,7 +119,7 @@ export const viteConfigFile = { | |||
| Please add a vite.config.js file to your project root. | |||
|
|
|||
| You can find more information on how to do this here: | |||
| https://storybook.js.org/docs/8.0/migration-guide/#missing-viteconfigjs-file | |||
| https://storybook.js.org/docs/migration-guide#missing-viteconfigjs-file | |||
There was a problem hiding this comment.
See prior comment
| https://storybook.js.org/docs/migration-guide#missing-viteconfigjs-file | |
| https://storybook.js.org/docs/8.0/migration-guide#missing-viteconfigjs-file |
Closes #29352
With this pull request, the links included in the monorepo were updated to address the recent updates to the documentation, preventing them from generating errors (e.g., 404 and 500).
What was done:
This body of work may require patching back to the
mainbranch and released as a patch version. I would leave it up to the rest of the maintainers to address how best to proceed.Greptile Summary
Updated documentation links across multiple files in the Storybook codebase to fix broken and outdated references.