typed-ember / glint

TypeScript powered tooling for Glimmer templates
https://typed-ember.gitbook.io/glint
MIT License
110 stars 51 forks source link

Fix broken links on "Getting Started" page #564

Closed HeroicEric closed 1 year ago

HeroicEric commented 1 year ago

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.

dfreeman commented 1 year ago

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!