Skip to content
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

Fix links broken by section heading changes #107

Closed
plocket opened this issue Feb 18, 2021 · 1 comment
Closed

Fix links broken by section heading changes #107

plocket opened this issue Feb 18, 2021 · 1 comment

Comments

@plocket
Copy link
Collaborator

plocket commented Feb 18, 2021

I think some name format headings changed and may need to be updated. Some may just have been made incorrectly to begin with because I didn't understand docusaurus's way of making urls safe.

Procedure for making sure you have the right link text to an internal link:

  1. Go to the heading you will want to link.
  2. Look at your address bar.
  3. Copy the part from # onwards
  4. If you want to link from another page, use [link text](file_name.md#text-that-was-in-the-url)
  5. If you want to link from within the same page, use just [link text](#text-that-was-in-the-url)
@BryceStevenWilley BryceStevenWilley self-assigned this Mar 17, 2021
@BryceStevenWilley
Copy link
Contributor

TIL that facebook/docusaurus#3059 exists, and docusaurs warns you when internal links are broken. Neat.

I think that this is good guide, but as an issue should be fixed? If we ever change internal headings, we'll know what internal links are broken, and TBH I don't think we need to be afraid of breaking other people's links to specific headings on our site. Gonna go ahead and close this.

@BryceStevenWilley BryceStevenWilley removed their assignment Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants