doc-lint

Solid

Lint and fix documentation issues, covering prose style with Vale and markdown formatting with rumdl

Code & Development 73 stars 6 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
62
Recency 20%
100
Frontmatter 20%
40
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation linting Lint and fix documentation issues in markdown and MDX files. This skill runs Vale for prose style and rumdl for markdown formatting, then applies fixes based on the output. ## Quick reference | Tool | Recipe | What it checks | | ------------ | -------------------- | -------------------------------------------- | | Both | `just lint-docs` | Run spelling, prose, and markdown linting together | | cspell | `just lint-spelling` | Spelling errors, typos, and misspellings. | | vale | `just lint-prose` | Prose style, AI vocabulary, hedging, clarity | | rumdl | `just lint-markdown` | Markdown formatting, structure | <!-- vale ai-tells-experimental.HeadingTitleCase = NO --> ## Core workflow ### Step 1: Run linters Run both linters on the target files. **For specific files:** ```bash just lint-docs path/to/file.md ``` **For all files:** ```bash just lint-docs ``` You can also run linters individually with `just lint-spelling`, `just lint-prose`, or `just lint-markdown`. ### Step 2: Interpret output Categorize issues by type: 1. **Auto-fixable markdown issues** - Fix directly: heading levels, list formatting, spacing 2. **Prose style issues** - Require judgment: rewrite sentences, simplify language 3. **Spelling issues** - Decide: add to accept.txt or cspell.json or rewrite 4. **Vocabulary issues** - Decide: add to accept.txt and/or cspell.json or...

Details

Author
tbhb
Repository
tbhb/vale-ai-tells
Created
8 months ago
Last Updated
2 days ago
Language
Shell
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

doc-standards

Documentation writing-quality standards — controlled language (ASD-STE100), Google/Microsoft style guide rules, ISO 24495 plain language, AI/agent readability (llms.txt, self-contained sections), and a machine-checkable lint gate. Use whenever writing or reviewing ANY documentation prose — README, API reference, tutorial, how-to, changelog, error message, code comment blocks, llms.txt — even if the user only says "write docs", "document this", "improve the README", "docs smell like AI", or "make the docs clearer". Structure/coverage questions (which doc types exist) belong to a Diátaxis-structure skill if one is installed; THIS skill governs how each sentence and section is written, and provides the lint gate to verify it.

13 Updated 4 weeks ago
JuanMarchetto
AI & Automation Solid

fix-prose

Clear the vale and cspell findings on a document whose content is already settled. A forked writer does the rounds and an independent reviewer reads the result, so the finding text never reaches this session. Takes the file plus the lint command that judges it. Use it when a draft is written but its prose gates are still red, or when a lint task has come back with findings more than once.

73 Updated 2 days ago
tbhb
Data & Documents Listed

docs-style-tone

Tighten the prose of your docs without rewriting by hand. Flags passive voice, filler words, marketing adjectives, runaway sentences, missing second person and inconsistent terminology — and returns issues per page without touching the files. Pair with /docs-create or /docs-analyze.

1 Updated 4 days ago
Docsbook-io