Brohammad / Brohammad/VoxForge
CI check for broken internal Markdown links
- Dominant language
- Python
- Stars
- 4
- Forks
- 1
- Avg merge
- 5d 13m
- Merged PRs (30d)
- 10
Description
## Summary
Docs are heavily cross-linked. Nothing in CI fails a moved/renamed `.md` path.
## Scope
- lychee, markdown-link-check, or similar on `README.md`, `CONTRIBUTING.md`, `docs/`, `examples/*/README.md`
- Fail on broken **internal** relative links
- Allowlist flaky external URLs (live demo, shields.io) so the job is not noise
## Acceptance criteria
- [ ] Config committed
- [ ] Green on current main
- [ ] A deliberately broken relative link fails the job
Do not rewrite docs except to fix links the checker finds.
Contributor guide
Research direction
Start by reviewing the current CI setup and the Markdown paths listed: README.md, CONTRIBUTING.md, docs/, and examples/*/README.md. Configure a checker for broken internal relative links, allowlist the named flaky external URLs, and verify that current main passes while a deliberately broken relative link fails.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 75/100