AI Reviewer

Hyperlint is a GitHub App that provides AI powered technical writing assistance to documentation teams.

This documentation will share how to get feedback from Hyperlint.

Hyperlint is like a 24/7 co-worker. Hyperlint will automatically review and respond to changes that you make in your repository assuming they meet the following basic criteria:

1. The change is a valid file type (e.g., markdown)
2. The change is a valid change (e.g., a change in text, formatting, or a change in the file's structure)
3. You have sufficient credits.

Here's what you'll get with a review

1. Inline comments where appropriate.
2. Recommendations on how to improve the content.
3. Recommendations on whether or not the style guide should be updated.

Testing the style guide

Often times, you'll want to test the style guide or debug what exactly the style guide sees or communicates. To do this, you'll need to create a special file and open a pull request.

The file path is: .hyperlint/style_guide_test.md

You can put whatever content you would like into this file. For instance, if you wanted to check whether it flags the misspelling of a product name, you could put the following content into the file:

# Test File

- hyPERlint
- Hyperlint
- hyperlint

You then get results back according to which issues are identified. Push a new change to that pull request and you'll see new results as a comment.

How to resolve reviews from Hyperlint

FAQ

How do I customize the style guide?

See Customizing the style guide for more information on customizing the style guide.

Expected Behavior & Limitations

Hyperlint's AI Reviewer has several limitations.

1. Hyperlint AI Reviewer currently only supports/reviews: (a) Markdown files with the .md or .mdx file extensions. Please reach out to support if you would like to request another extension.
2. Hyperlint AI Reviewer currently only supports English.
3. Hyperlint AI Reviewer currently only integrates with GitHub. Please reach out to support if you would like GitLab or Bitbucket support.
4. If there are more than 25 files to review in a pull request, Hyperlint will not review the pull request. This is to prevent abuse and excessive credit usage.

How do I prevent Hyperlint from reviewing a pull request?

Add the label hyperlint-ignore to the pull request. This will prevent Hyperlint from reviewing the pull request.