project-docs

Generate project documentation for hybrid systems by producing a README, C4 and Mermaid architecture diagrams, ADRs, and a Model Card. This approach ensures both traditional code and AI agent operations are captured within a standardized, auditable MkDocs structure.

Docs-as-code treats documentation like software, versioning it alongside source code. Using MkDocs, you structure markdown files into a navigable site, ensuring outputs like ADRs and MODEL_CARD.md are discoverable and ready to commit.

Create architecture diagrams using C4 and Mermaid by defining system context, containers, and components, plus sequence diagrams for complex systems. This visualizes hybrid software architecture directly within your markdown documentation.

ADRs and Model Cards are essential for AI agent projects to track architectural decisions and document model behavior. Maintaining these files ensures consistent, auditable documentation across teams operating hybrid software systems.

Track prompts in your documentation by maintaining a PROMPT_REGISTRY.md file. This docs-as-code practice logs prompts alongside ADRs and architecture diagrams, keeping prompt usage versioned and auditable within the MkDocs structure.