Genesis Documentation
Automatically document your codebase with AI-powered analysis
Genesis is Quoth's automated documentation system. It analyzes your codebase and creates structured documentation that AI agents can use to understand your project.
How Genesis Works
Configuration - Genesis asks about your preferred documentation depth
Analysis - Your AI tool reads local files using its native capabilities
Documentation - Each document is created and uploaded incrementally
Indexing - Documents are embedded for semantic search
Depth Levels
Genesis offers three depth levels to match your documentation needs:
| Level | Documents | Time | Best For |
|---|---|---|---|
minimal | 3 | ~3 min | Quick overview, prototypes |
standard | 5 | ~7 min | Team onboarding, regular development |
comprehensive | 11 | ~20 min | Enterprise audit, full documentation |
Minimal (3 Documents)
project-overview.md- High-level system overviewtech-stack.md- Dependencies and frameworksrepo-structure.md- Directory organization
Standard (5 Documents)
Everything in minimal, plus:
coding-conventions.md- Code style and patternstesting-patterns.md- Test structure and examples
Comprehensive (11 Documents)
Everything in standard, plus:
api-schemas.md- REST/GraphQL endpointsdatabase-models.md- Tables and relationsshared-types.md- TypeScript interfaceserror-handling.md- Error patternssecurity-patterns.md- Auth and validationtech-debt.md- Known issues and improvements
Running Genesis
Activate the architect persona and request Genesis:
/prompt quoth_architect
"Run Genesis with comprehensive depth"
Genesis respects your .gitignore and won't document sensitive files like .env or node_modules.
Updating Documentation
Genesis creates initial documentation, but keeping it current is important. You have two options:
Incremental Updates
Use the documenter persona to update specific sections:
/prompt quoth_documenter
"Update the API schemas documentation with the new /users endpoint"
Full Regeneration
Run Genesis again with update_only focus:
/prompt quoth_architect
"Run Genesis with update_only focus to refresh documentation"
Best Practices
Start Small
Begin with minimal depth, expand as needed
Keep Current
Run Genesis after major changes
Review Output
Verify generated docs match your project