Broken links should fail the build
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 13
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
When building the website, if any of the links to other docs (not links to definitions like terms or types) results in a hash or is in other ways malformed, the build should fail, such that we are notified about broken links before they go live.
Note that we might currently be relying on hashes as a way to link to share, meaning, when we see a hash in a link we assume its a link to share. We'd need to differentiate navigational doc links and definition links in some way to catch hashes as errors.
cc @rlmark
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named in the issue, so start by locating the website build and link-processing code. Done means malformed navigational documentation links, including unintended hashes, fail the build while definition or sharing links remain valid.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100