AI Reviewer
Hyperlint’s AI Reviewer provides comprehensive documentation review capabilities through 2 main features: Style Guide Checking and Link Checking.
Why are Hyperlint reviews better?
Integrated
Hyperlint is tightly integrated with GitHub pull requests, providing a seamless experience for you to get a review and act on it.
Suggestions, not just issues
Hyperlint won’t just complain when you have an issue. It will also surface a suggestion, inline, for that problem. This makes it trivial to fix any issues that come up.
Checks and inline reviews
Hyperlint provides review as GitHub pull request checks in addition to inline review comments. That makes it easy, as a reviewer, to understand exactly what the issues are.
Just resolve the problems to get the ✅
If a review comment doesn’t make sense in this case, just close the review comment. Upon fixing or closing all review comments, Hyperlint will give you a ✅!
Style Guide Integration
Hyperlint allows you to customize its review behavior through a style guide configuration. This helps ensure the reviewer provides relevant feedback for your specific documentation needs.
Hyperlint supports two versions of Style guide checking: either in isolation or in combination.
You can run a custom style guide, where you define arbitrary rules, and our AI will enforce them. Alternatively, you can define specific Vale rules that we will enforce on your behalf.
Custom Style Guide
A custom style guide is an arbitrary text file (usually the same file type as your documentation) that contains a list of rules that Hyperlint will check against your documentation. These rules are in plain english.
You’ll need to create a file and then tell Hyperlint where to find it by putting the path in the configuration file.
Vale Style Guide
Vale is a powerful syntax-aware linter that helps enforce style guide rules.
It’s great, but it’s a little finnicky and can take some time to set up.
Follow a standard setup process for Vale. We’ll automatically file the .vale.ini file in the root of your repository. Custom vale paths outside of the root directory are not supported at this time.
Link Checking
Hyperlint will check all external links in your documentation to ensure they are valid.
Supported File Formats
At this time Hyperlint supports three file types to review:
- Markdown files (
.md,.mdx) - ReStructuredText Files (
.rst) - Asciidoc Files (
.adoc)
File Limitations
We do not support Vale Reviews on Asciidoc files at this time. Please contact support if you’d like to request support.