Added a script to check the validity of docs links and a .github action #122
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
Well, in at least some cases, just remove broken links. - The BSATN ref contained links to type defns, but didn't have type defns. Replace the links with plain text. - HTTP database links for recovery-code related routes were getting mangled in some way I couldn't figure out, so the links weren't working despite their targets clearly existing. Conveniently, those routes have been removed, so remove the links and the corresponding sections. - The JSON doc (erroneously called "SATN") contained typos, spelling "producttype" as "productype". - C# SDK ref had links to a section on the `Address` type, but no such section. Replace the links with plain text. - Rust SDK ref had a link getting mangled in a way I couldn't figure out. Simplify the section title so that the anchor name is predictable. - TypeSciprt SDK ref used camelCase names in anchor links, but we downcase all section titles to create anchor names. Also slap a section in README.md which says how to run the checker locally.
gefjon
approved these changes
Jan 2, 2025
There was a problem hiding this comment.
I have run the script locally and can confirm that it identified several broken links, which I then fixed. I am not confident that it mangles header text into anchor names correctly. I have no particular reason to believe it does not, I'm just pointing out that I have not tested or validated that the actual website uses the same format for anchors.
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.
This pull request introduces new GitHub Actions workflows for validating documentation links and ensuring that the
nav.tsfile builds correctly. Additionally, it includes updates to thenav.jsfile and thepackage.jsonfile, and adds a new script for checking links in markdown files.New GitHub Actions workflows:
.github/workflows/check-links.yml: Adds a workflow to check the validity of links in the documentation..github/workflows/validate-nav-build.yml: Adds a workflow to validate that thenav.tsfile builds to match the committednav.jsfile.Code updates and new scripts:
docs/nav.js: Refactors thepageandsectionfunctions to use explicit parameter assignments and changesconsttovarfor thenavobject.package.json: Updates dependencies and modifies thebuildscript to output to thedocsdirectory. Adds a newcheck-linksscript.scripts/checkLinks.ts: Adds a new script to check for broken links in markdown files by comparing them against the slugs defined in thenav.tsfile.Testing
I ran this locally and verified that we have broken links. I would like to check that this action runs and does not allow merging.