All products

Set up Vale for documentation with AI

Configure Vale for the prose your team actually writes. Select a style, match the right file formats and inspect the first report.

Set up Vale for documentation with AI when a repository contains both authored guides and generated reference pages. The setup skill helps an agent point Vale at the writing your team can change. Checking a single real page first reveals whether the configuration sees the intended format and loads the chosen rules.

Pick the editorial style before syncing packages. A guide intended for conversational help text may have different expectations from a formal reference manual. The first report preserves the distinction between an error and a suggestion, so the team can judge the starting point without hiding a noisy rule.

What it does

  • Locate authored prose in documentation folders or at the repository root.
  • Select rules with the people who own the project’s writing style.
  • Match Markdown, MDX, AsciiDoc or another format actually present in the project.
  • Keep downloaded style packages out of version control as instructed.
  • Lint one known page and report the count at each severity.

Install and use

  1. Install the skill and the official Vale CLI using the documented package manager or issuer release. Open the documentation project.
  2. Ask “Set up linting for the hand-written guides and show me a real example before we choose a style.”
  3. Sync the agreed package, check one file and inspect the named alerts before extending the run.

FAQ

Source

Made by Joseph Kato (Vale). Original skill: setup, published on GitHub under the MIT licence.

View on GitHub