This section covers everything you need to develop, test, and contribute to CodeWiki itself — the AI-powered documentation generator, not a repository you're documenting with CodeWiki.
CodeWiki is a Python package (pyproject.toml, Python >=3.12) organized around a CLI (codewiki/cli), a backend documentation pipeline (codewiki/src/be), a FastAPI web application (codewiki/src/fe), and a shared runtime configuration model (codewiki/src/config.py).
| Guide | Description |
|---|---|
| Environment Setup | IDE recommendations, required tools, and development environment variables. |
| Local Development | Cloning the repo, installing in editable mode, running the CLI and web app locally, and debugging. |
| Architecture Overview | High-level module architecture, core components, and data flow through the documentation pipeline. |
| Security | Credential storage, safe file access, input validation, and secure coding practices used in CodeWiki. |
| Testing | Structure of the diagnostic/validation scripts, how to run them, and expectations for new tests. |
| Contributing Guidelines | Code style, branch naming, commit format, and the review checklist for pull requests. |
- Read the Architecture Overview to understand how the CLI, backend, and frontend modules fit together.
- Follow Environment Setup and Local Development to get a working local copy of CodeWiki.
- Review Security and Testing before submitting changes.
- Read Contributing Guidelines before opening a pull request.