Welcome to the documentation for CodeWiki — an AI-assisted documentation generator that analyzes source repositories, builds dependency graphs, clusters components into logical modules, and uses LLM-backed agents to produce hierarchical Markdown documentation.
New to CodeWiki? Start here:
- Introduction — What CodeWiki is, key features, and target audience
- Prerequisites — Required software, accounts, and environment variables
- Quick Start — Run the CLI locally or the web app via Docker Compose, and generate your first documentation set
- First Steps — What to explore and configure after your first successful run
Guides for developing, extending, and contributing to CodeWiki:
- Development Overview — Index of all development documentation
- Environment Setup — IDE recommendations, required tools, and environment variables
- Local Development — Running the CLI and web app from source, hot reload, and debugging
- Architecture Overview — How CodeWiki's modules fit together and data flow
- Security Best Practices — Secret handling, credential storage, and input validation patterns
Technical reference documentation generated directly from source code analysis:
Top-Level Overview
- Repository Overview — End-to-end architecture, generation lifecycle, and module relationships
- Ecosystem — Repository graph and dependency ecosystem
CLI Core (codewiki/cli) — Terminal workflow, configuration, generation pipeline
- CLI Core Overview
- Configuration Management
- Job and Generation Models
- Generation Pipeline
- CLI Utilities
Backend Core (codewiki/src/be) — Dependency analysis, clustering, LLM-driven generation
- Backend Core Overview
- Documentation and Services
- Agent Orchestration and Tools
- Dependency Analysis:
Frontend Core (codewiki/src/fe) — FastAPI web application
- Frontend Core Overview
- Request Handling
- Job Processing
- GitHub Integration
- Configuration and Data Models
Config Core (codewiki/src/config.py) — Shared runtime configuration
Test Multi Path Core (test-multi-path) — Multi-source-path analysis validation
Test Clustering Core (test_clustering) — Module clustering validation
Visual architecture documentation is available as Mermaid diagram source files:
- Browse diagram files under
./diagrams/architecture/— includes flowcharts and sequence diagrams for the backend, frontend, CLI, config, dependency-analysis, and test modules covered in the Reference section above.
- Project README — Main project README
- Contributing — How to contribute
- License — License information
Documentation generated by 🦩 Flamingo Code Documentation