[doc] Run Lychee link checker in Bazel sandbox
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
We run the Lychee link checker over our Markdown files to find broken links.
Recently we moved the mdbook build into Bazel, so it runs inside of a sandbox while Lychee does not. This can cause false negatives where Lychee can see the file but mdbook inside Bazel cannot.
We should run Lychee within the same sandbox so it sees the same files as mdbook.
Contributor guide
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
Inspect the Bazel mdbook build and the existing Lychee invocation, using the issue description as the starting point since no file paths are provided. Run the relevant documentation check and verify that Lychee executes inside the same Bazel sandbox as mdbook and sees the same Markdown files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100