documentation-quality-standards

A set of documentation rules for the LeanSpec documentation website. It requires documentation paths and sidebar links to follow the same structure and includes checks for broken links and successful builds.

In plain words
What is it for?
Use it when adding, moving, or restructuring LeanSpec documentation, especially when updating sidebar entries, folders, links, or the documentation build.
Why use it?
It prevents pages from appearing in the wrong place or becoming unreachable through the site's navigation. It also gives contributors a consistent way to verify documentation changes.

Agent

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add agents/codervisor/leanspec/documentation-quality-standards
Clone the repo
git clone --depth 1 https://github.com/codervisor/leanspec
Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,475 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.02475
Opus 5 $0.00000 $0.01238
Sonnet 5 $0.00000 $0.00495
Haiku 4.5 $0.00000 $0.00248

Measured 2d ago against content hash 921d143d5fdd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-quality-standards scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

docs-site/agents/documentation-quality-standards.md · 337 lines

How it starts

The opening of the file, as written. The whole thing — 337 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Quality Standards

Comprehensive guidelines for maintaining high-quality documentation in the LeanSpec documentation site.

1. File Path and Sidebar Alignment

CRITICAL: Documentation file paths MUST always align with the sidebar structure.

Examples

  • Sidebar: Usage → CLI Usage → Creating & Managing Specs

  • File path: ./docs/guide/usage/cli/creating-managing.mdx

  • Sidebar: Usage → Overview

  • File path: ./docs/guide/usage/overview.mdx

Rule

The folder structure should mirror the sidebar hierarchy exactly. If the sidebar shows a nested structure, the file system must reflect that nesting.

Verification Checklist

After any documentation restructuring, always verify:

  1. File paths match sidebar item to or label values
  2. Folder nesting matches sidebar category structure
  3. Build succeeds with npm run build (no broken links)

File Path Patterns

docs/
├── guide/
│   ├── index.mdx                    → sidebar: "Guide"
│   ├── usage/
│   │   ├── overview.mdx            → sidebar: "Usage → Overview"
│   │   ├── cli/
│   │   │   ├── creating-managing.mdx   → "Usage → CLI Usage → Creating & Managing"
│   │   │   └── finding-specs.mdx       → "Usage → CLI Usage → Finding Specs"
│   │   └── advanced-features/
│   │       └── templates.mdx           → "Usage → Advanced Features → Templates"

2. Chinese Translation Completeness

CRITICAL: Chinese documentation must ALWAYS align with English documentation. NO MISSING translations.

Requirements

  • Every English .mdx file MUST have a corresponding Chinese translation in i18n/zh-Hans/docusaurus-plugin-content-docs/current/
  • Folder structure in Chinese docs MUST mirror English docs exactly
  • When adding new English docs, immediately add Chinese translations
  • When moving/renaming English docs, move/rename Chinese docs identically

Verification Commands

# Check English structure
find docs/guide -name "*.mdx" | sort

# Check Chinese structure (should match)
find i18n/zh-Hans/docusaurus-plugin-content-docs/current/guide -name "*.mdx" | sort

Read the full file on GitHub · 337 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 337 lines · 0 tokens per session scan A 921d143d5fdd

Subscribe to this mod's changes

documentation-quality-standards is an agent published in the GitHub repository codervisor/leanspec (287 stars, last pushed 3mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 2,475 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.