Code Documentation

Conventions and templates for README.md files that serve as LLM-optimized navigation documents for codebase directories.

When to Use

• After implementing code that creates or deletes files in a directory
• When a new directory is created that contains code or configuration
• When reviewing documentation freshness during development
• When /m:dev Step 8 triggers documentation updates

Purpose

README.md files are LLM-optimized navigation documents. They allow an agent to:

1. Scan frontmatter across many directories to decide which are relevant (fast)
2. Read full content of relevant READMEs to understand module structure (deep)
3. Navigate diagrams to understand relationships, data flow, and state machines