Personal project · Tooling
Doclify Guardrail: checking a repository’s documentation
A CLI published on npm that checks links, commands and references in a repository’s Markdown and MDX files. To catch what doesn’t add up before the reader does.
The problem
Documentation can be well written and point to a file that no longer exists. It can also describe a command the project does not expose. Doclify Guardrail checks these references in the context of the repository.
What I built
A CLI published on npm that analyses Markdown and MDX files and flags problems with links, commands and references. The project brings part of documentation review closer to the code: checks become repeatable and can be included in repository verification.
How to evaluate it
The public repository contains the implementation, instructions and tests. A useful case is documentation that changes alongside software, including when AI tools take part in writing it. Automated checks help find inconsistencies; the meaning of the explanations still needs a review.