Documentation Standards

Package docs should describe the real runtime, not a hoped-for future runtime.

Standards

• use stable, descriptive names for pages and headings
• anchor claims to real commands, paths, modules, or artifacts
• document limitations and migration risks directly instead of hiding them in review comments
• update docs in the same change that alters a public command, output path, or package boundary

Purpose

This page records the writing rules that keep the package handbook trustworthy.