doc-lint

Solid

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

Code & Development 110 stars 12 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
68
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
9 months ago
Last Updated
3 days ago
Language
Shell
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Code & Development Listed

docs-linter

Set up and tune a Vale style gate for a documentation set: install, pre-commit and CI wiring, ready rule files for hedging, filler, vague obligation and abbreviations, and the config traps that cost an afternoon each. Use this skill whenever documentation style needs enforcing rather than advising - adding the linter to a repository, writing or tuning a rule, or working out why a rule fired or stayed silent. Trigger it when someone asks to 'check the docs automatically', 'stop people writing X' or 'add a style check to CI'. Do NOT use it for the writing rules themselves, which live in technical-writing, or for Markdown structure, which is markdown-formatting.

0 Updated 4 days ago
pavelzaitsau
Data & Documents Listed

markdown-linting

Markdown linting for this workspace: MD029 list numbering, MD040 code block language tags, MD051 anchor links, and the closing-fence mistake that breaks HTML generation. Use when: writing or editing any .md file, running markdownlint-cli2, fixing MD029/MD040/MD051 errors, generating HTML or PDF from markdown. Do NOT use for: the general documentation standard (use the documentation skill) — this is the linter-specific subset.

0 Updated today
ragnarwestad
AI & Automation Listed

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.

17 Updated 2 months ago
JuanMarchetto