Linter

The Linter automates the time-consuming work of checking content against your style guide and automated tooling that writers traditionally use. You can add rules for spelling and grammar, word choice, and to ensure content is written according to your organization’s guidelines and best practices.

---

Configure

You can add prompts to the Linter that is categorized as an error, warning, or style guide.

Errors: Rules that can be checked objectively. Example:

Capitalize ReadMe properly:

Bad: Readme

Good: ReadMe

Warnings: To point out issues that may be subjective. Example:

Hedging Language:

Avoid using uncertain or overly cautious language. It undermines confidence and make your instructions less direct. Opt for clear, confident language.

Bad: You might want to consider installing the latest version.

Good: You can install the latest version to access new features.

Style Guide: Write about what makes for great docs and the Linter will score your content. Example:

Keep it short:

Short text is always better. Short paragraphs are easier to read. Try to keep headings to one line. Two-line headings take up twice as much vertical space. Use short words in headings; if a customer uses larger fonts to improve accessibility, long words may break across lines.

Running the Linter

Once configured, running the Linter checks your page against your prompts. Issues can be fixed automatically using the AI Agent.

FAQ

Where should I send feedback or questions?

Email feedback or questions to [email protected]

What model does the Linter use?

At the moment we use Gemini 2.5 Flash—though that may change as we adjust to balance quality and speed. In the future users will have the option to select models of their choice.