matrix-org / matrix-org/matrix.org
Add link checker CI
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 616
- Forks
- 463
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 19
Description
Zola can check our links actually work. To profit from this, we should
- [ ] document this requirement in CONTRIBUTING or similar and in PR template.
- [x] ~~add CI. probably we only want it to verify internal links since external links would be too slow to check and outside our control anyway hence could break at any time.~~ this is already in CI just by building zola. however it only applies when using zola's special internal link format:
- [ ] convert all internal links currently implemented as external links (`https://matrix.org/somewhere` instead of `@/somewhere.md`) to proper internal links
- [ ] convert all internal links currently using default format (`/somewhere` instead of `@/somewhere.md`) to proper internal links
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
Start by reading CONTRIBUTING and the PR template, then inventory internal links using the formats described in the issue. Check how the existing CI build validates Zola links. Done means the requirement is documented and all internal links use the proper internal-link format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100