code-documentation

To generate an LLM-optimized README, apply standardized templates that validate frontmatter, produce a structured files table, and insert Mermaid diagrams for module structure. This ensures your codebase directories remain consistent and quickly discoverable by agents.

Required frontmatter fields for discoverable markdown documentation include module, purpose, and last-updated. Validating these fields ensures your README files meet the standardized conventions required for quick agent navigation and codebase discovery.

Adding Mermaid diagrams to a README is handled automatically by applying the standard documentation templates. The process generates the necessary diagram syntax to illustrate module structure and data flows alongside the structured file listings.

The best way to standardize README files across a codebase is to apply uniform documentation templates that enforce frontmatter validation, generate consistent file listings, and include standard references. This maintains consistency across all directories containing code or configuration.

No specific dependencies are required to validate markdown frontmatter and generate file tables. The guidance applies standard README templates directly to your target directories to enforce frontmatter rules and structure your documentation conventions.