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 broken links on "Getting Started" page #564

Merged
merged 1 commit into from
Apr 27, 2023

Conversation

HeroicEric
Copy link
Contributor

@HeroicEric HeroicEric commented Apr 27, 2023

Fixes two broken links on "Getting Started" page.

Side Note

There are a few other broken links throughout the docs but I don't understand how/why they're broken and they seem to magically sometimes not be broken in different preview versions.

For example, in the current live version of the "Getting Started" page the link to "Ember.js Installation" does not work. The path looks correct to me and the link works properly on GitHub when previewing the markdown files.

If you view the preview "revision" linked by GitBook in the checks for this PR this link is magically fixed. I'm not sure if that means that it will actually be fixed after merging this though.

Another example is the link to "Authoring Guide" on the "Using Addons" page. This link is broken in the live version AND the preview revision for this branch but seems to fix itself if ANY changes are made to the markdown file for page.

@HeroicEric HeroicEric marked this pull request as draft April 27, 2023 01:44
- Removes link to docs page for `glint-language-server` that was removed in
  typed-ember#416
- Fixes broken link to "Configuration"
@HeroicEric HeroicEric changed the title Remove broken link to glint-language-server docs page Fix broken links on "Getting Started" page Apr 27, 2023
@HeroicEric HeroicEric marked this pull request as ready for review April 27, 2023 01:58
@dfreeman
Copy link
Member

Thank you! Internal link rot in these docs has definitely been a struggle—I try and do a pass any time something moves or changes, but inevitably we wind up with stragglers.

This link is broken in the live version AND the preview revision for this branch but seems to fix itself if ANY changes are made to the markdown file for page.

I honestly have no clue what's going on there 🤔
I wonder if we have any options to force a rebuild of all the pages on the GitBook side... regardless, thanks for flagging these!

@dfreeman dfreeman merged commit f233e45 into typed-ember:main Apr 27, 2023
@HeroicEric HeroicEric deleted the update-docs branch April 27, 2023 15:55
@dfreeman dfreeman added the documentation Improvements or additions to documentation label Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants