Run Docs as a First-Class Gate
TEST-RUN-DOCS-AS-FIRST-CLASS-GATE
Summary
Treat documentation checks as real validation for examples, links, commands, and claims. Prose-only edits may need less proof, but API-facing docs should fail before stale guidance ships.
Rule
Run docs as a first-class validation job.
Why
Docs contain commands, examples, feature claims, public API paths, and Rustdoc links. Treating docs as a secondary check lets stale examples and broken rendered docs ship even when code tests pass.
Helps
- Keeps documentation, examples, and public API contracts aligned with code.
Limits
Small prose-only edits may only need markdown lint and link review. Run stronger docs gates when examples, Rustdoc, features, or public behavior claims change.
Agent Instruction
Run docs as a first-class validation job because docs contain commands, examples, feature claims,
public API paths, and Rustdoc links.Mechanisms
Supported by markdownlint-cli2, cargo test --doc, cargo doc --no-deps, docs.rs-style builds,
link checks, and rendered-doc review.