README.md

CodeWiki Documentation

Welcome to the documentation for CodeWiki — an AI-powered documentation generator for source code repositories.

📚 Table of Contents

Getting Started

New to CodeWiki? Start here:

• Introduction — What CodeWiki is, key features, and target audience
• Prerequisites — Required software, versions, and environment setup
• Quick Start — Install CodeWiki and generate your first documentation set in ~5 minutes
• First Steps — Customizing generation, tuning token budgets, and the Git/GitHub Pages workflow

Development

Contributing to CodeWiki itself:

• Development Overview — Quick navigation for developing, testing, and contributing
• Environment Setup — IDE recommendations, required tools, and dev environment variables
• Local Development — Cloning the repo, editable installs, and running the CLI or web app locally
• Architecture Overview — High-level module architecture, core components, and data flow

Reference

Technical reference documentation generated from source-code analysis:

• Reference Overview — End-to-end architecture, module relationships, and summary
• CLI Core — Command-line orchestration, local config, Git integration, HTML generation
• Backend Core — Repository analysis, dependency graphs, module clustering, LLM agent orchestration
• Frontend Core — FastAPI web application, job processing, caching, doc serving
• Config Core — Shared runtime Config model for paths, provider settings, and agent instructions
• Test Multi Path — Fixtures and checks for multi-root source analysis
• Test Clustering — Diagnostic and validation scripts for LLM-based module clustering

Backend Core Subsystems

• Agent Tools Core — Controlled repository inspection and documentation editing tools
• Dependency Analyzer Core — File discovery, AST parsing, call analysis, and graph construction
  • Graph Construction
  • Analysis Pipeline
• Tree Sitter Analyzers — Language support for C, C++, C#, Java, JavaScript, TypeScript, PHP, and Python
  • Python Analyzer
  • PHP Analyzer
  • JavaScript/TypeScript Analyzers
  • Java Analyzer
  • C-Family Analyzers
• Dependency Analyzer Models — Repository, node, relationship, and analysis-result contracts
• Documentation Generator — Top-level pipeline coordination and documentation output
• LLM Services — Model selection, request counting, and fallback handling
• Logging Config — Shared colorized logging support

CLI Core Subsystems

• Generation — CLI adapter for staged documentation generation
• Configuration — Persisted settings, keyring-backed credentials, and agent instructions
• Job Models — Generation job status, statistics, and LLM configuration models
• Git Integration — Clean-tree checks, branch creation, commits, and remote URL handling
• HTML Generation — Static documentation viewer generation

Test Fixtures Reference

• Test Suites
• Sample Fixtures

Diagrams

Visual documentation — Mermaid architecture diagrams generated from source-code analysis are available in:

• ./diagrams/architecture/ — includes diagrams for the CLI, backend, frontend, config core, dependency analyzers, and test modules

📖 Quick Links

• Project README — Main project README
• Contributing — How to contribute
• License — License information

💬 Community

CodeWiki does not use GitHub Issues or Discussions. For questions and discussion, join the OpenMSP Slack community: https://www.openmsp.ai/ (join link).

---

Documentation generated by 🦩 Flamingo Code Documentation