Quick Start
Getting setup and started with Hyperlint
Introduction to Hyperlint
Hyperlint is an AI-powered tool designed to assist technical writing and developer content teams by enhancing the quality of documentation. It does this in several ways:
- Helping review documentation changes.
- Helping keep documentation up to date.
Hyperlint can actively monitor your documentation repository and offer actionable feedback for improvement. Additionally, Hyperlint keeps track of API updates, ensuring that your documentation reflects the latest changes and remains contextually accurate.
Getting Started
Install Hyperlint
First, ensure Hyperlint is installed on your GitHub repository. For installation instructions, please refer to our installation guide.
Push a documentation change to your repository.
To initiate a Hyperlint review, simply open a pull request in your documentation repository. If you're changing a valid file type (e.g., markdown), Hyperlint will automatically detect the changes and provide feedback.
For a practical demonstration, visit our demo repository to observe a Hyperlint review.
Set the Hyperlint Configurations
Once you've gotten your first review, you can go about customizing Hyperlint to better fit your needs. Hyperlint offers several optional configurations for customization. To explore these options, please visit the configuration page.