What
Several README links point to missing pages under docs/guides/ (build guide, troubleshooting, performance tuning). Create these pages so the README becomes navigable.
- Current: Broken internal links in
README.md
- Expected: All referenced guides exist and render
- Scope:
docs/guides/BUILD.md, docs/guides/TROUBLESHOOTING.md, docs/guides/PERFORMANCE.md
Why
- Broken links signal an unmaintained project to new users
- First-touch developers need a build guide in one place
How
Technical Approach
- Audit README with
markdown-link-check in CI
- Populate missing pages, referencing existing README snippets
- Add
link-check.yml workflow
Acceptance Criteria
What
Several README links point to missing pages under
docs/guides/(build guide, troubleshooting, performance tuning). Create these pages so the README becomes navigable.README.mddocs/guides/BUILD.md,docs/guides/TROUBLESHOOTING.md,docs/guides/PERFORMANCE.mdWhy
How
Technical Approach
markdown-link-checkin CIlink-check.ymlworkflowAcceptance Criteria
README.mdmarkdown-link-checkruns in CI