-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: fix broken links #907
Merged
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
chihiro-adachi
approved these changes
Oct 24, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
リンク切れ解消されてました(プレビューで確認しました)!
問題ないかと思います。
chihiro-adachi
approved these changes
Oct 24, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTMです!
This was referenced Oct 24, 2024
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.
Why
Some relative links in our doc website are broken.
e.g. Stability Index to Versioning Policy
Root cause
There are two root causes: trailing slash and relative URL links.
trailing slash
By default, docusaurus generates
/docs/myDoc/index.html
for/docs/myDoc.md
.Amplify appends a trailing slash for the URL
/docs/myDoc
because/docs/myDoc.html
doesn't exist.Finally, accessing
/docs/myDoc/
equals/docs/myDoc/index.html
.trailingSlash: true
is suitable for Amplify.relative URL links
Specifying the
trailingSlash: true
will break some relative links.We'd better use a file path rather than a URL path described in the reference.
https://docusaurus.io/docs/markdown-features/links
What
trailingSlash: true
How to test
Preview: https://docs-fix-broken-error.d28lu13lljyj0a.amplifyapp.com/
Checklist
pnpm lint
andpnpm test
on the root directory.