Skip to content

docs: complete missing guide links (build, troubleshooting) #614

Description

@kcenon

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

  1. Audit README with markdown-link-check in CI
  2. Populate missing pages, referencing existing README snippets
  3. Add link-check.yml workflow

Acceptance Criteria

  • Zero broken links in README.md
  • markdown-link-check runs in CI
  • Three guides exist with examples

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions