Automations

Overview

Automated Fixes

Hyperlint Automations automatically fix certain documentation issues through three main features:

1. Broken Link Fixes - Automatically detects and fixes broken links in documentation
2. Meta Description Optimization - Adds SEO-optimized meta descriptions to documentation pages
3. Image Alt Text - Adds SEO and accessibility-friendly alt text to images

These automations help maintain documentation quality without manual intervention.

Automated Alerts and Proposals

Hyperlint Automations can monitor both CLIs and OpenAPI specifications for changes that might impact your documentation.

How it works

Hyperlint Automations aims to make maintaining API and CLI documentation effortless. It does this by monitoring two key areas:

CLI Monitoring

Hyperlint Automations monitors the public commands of your CLIs and looks for changes in:

1. The commands’ descriptions
2. The commands’ arguments
3. The commands’ parameters

OpenAPI Monitoring

For REST APIs, Hyperlint monitors your OpenAPI specifications and detects changes in:

1. Endpoint paths and methods
2. Request/response schemas
3. API descriptions and examples

For both monitors, if no changes are detected, Hyperlint will wait 24 hours before checking again.

When changes are detected in either system, the process continues to the next step.

Issue creation

In some cases and during the preview period, Hyperlint will automatically create issues in your repository. It will create issues describing:

1. The changes detected in the CLI
2. A diff of the changes
3. A suggestion on how to update the documentation to reflect the changes including the specific files and lines that might need to be updated.

Pull request creation

Coming soon

If Hyperlint is confident in the changes that it proposes, it will create a pull request with the suggested changes. This will be a pull request to your repository and default branch.

The pull request will contain the relevant information for you to be able to conduct a review. If, after your review, you’d like to accept the changes, you can merge the pull request. If not, just close it out!

Hyperlint cannot respond to changes on that pull request yet! You’ll have to merge it manually.

How to get started

Reach out to [email protected] to get started with the CLI Monitor.

Other Maintenance Agent Tasks

Hyperlint also supports other maintenance agent tasks, reach out to [email protected] if you’d like to learn more or ask about other monitors.