Docs: Fix broken links ending with ".mdx" #29051
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When I checked "How to contribute" page on storybook.js.org, a link titled "Continue reading our contributor covenant" pointed to GitHub's 404 page. The last item of the URL path was "CODE_OF_CONDUCT.mdx", which is not common filename people uses, therefore I suspected this is not the only broken link in the docs. And I was right. I ran the below command (rg = RipGrep) then found several 404 links. ``` $ cd docs $ rg "https?:[\S)]+mdx\)" --sort path ``` Git blame told me that some of ".md" to ".mdx" migration works accidentally changed non-docs URLs ending with ".md" too. StackBlitz URL in docs/api/main-config/main-config-indexers.mdx is not actually a dead link, as the service redirects to the `README.md`. However, the redirection takes loooong so I replaced that as well. There are still two links that match to the above regexp: * <https://github.com/storybookjs/storybook/blob/next/docs/get-started/setup.mdx> at docs/contribute/documentation/new-snippets.mdx L42 * <https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx> at docs/writing-docs/mdx.mdx but those two are both valid (alive) URLs.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM
7 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 6717970. 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. |
jonniebigodes
added
documentation
ci:docs
jonniebigodes
approved these changes
Sep 9, 2024
There was a problem hiding this comment.
@pocka, thank you for taking the time to put together this pull request and helping us improve the documentation by catching these issues with the links. We appreciate it 🙏 ! I've checked, and all is good on my end. I'm going to merge this once the checklist clears.
Hope you have a great day.
Stay safe
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #
What I did
Fixed several broken links in the Storybook docs.
See commit message for context.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Docs only change.
BTW I could not view the changes with https://github.com/storybookjs/frontpage because of storybookjs/frontpage#690.
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
This PR fixes broken links in Storybook documentation by updating file extensions from '.mdx' to '.md' for various files.
docs/configure/upgrading.mdx@storybook/nextjsindocs/contribute/framework.mdxdocs/contribute/index.mdxdocs/faq.mdx