Skip to content

README.md

Latest commit

 

History

History
106 lines (77 loc) · 5.68 KB

README.md

File metadata and controls

106 lines (77 loc) · 5.68 KB
Raw

CodeWiki Documentation

Welcome to the CodeWiki documentation. CodeWiki is an open-source, AI-powered documentation engine that transforms source code repositories into structured, hierarchical, and navigable technical documentation — automatically.

Built by Flamingo as part of the OpenFrame platform.

📚 Table of Contents

Getting Started

New to CodeWiki? Start here.

Document Description
Introduction What CodeWiki is, how it works, and who it is for
Prerequisites System requirements, LLM provider setup, environment configuration
Quick Start Get CodeWiki running and generate your first documentation in under 5 minutes
First Steps Explore key features: filtering, GitHub Pages, web interface, and configuration patterns

Development

Guides for contributors and developers working on CodeWiki itself.

Document Description
Development Overview Project structure, technology stack, and quick navigation
Environment Setup IDE configuration, VS Code extensions, code style, linting
Local Development Clone, run, debug, Docker setup, and development workflow
Architecture Overview High-level system design, data flow, and key design decisions

Reference Architecture

Deep-dive technical documentation for each CodeWiki module, generated by CodeWiki from its own source code.

Module Description
Repository Overview End-to-end architecture and module summary
CLI Core Command-line engine, config management, Git integration, progress tracking
Agent Orchestration AI agent lifecycle, tool injection, request limits, module persistence
LLM Services LLM provider abstraction, fallback chaining, multi-provider configuration
Documentation Generation Orchestration backbone, bottom-up processing, synthetic module fallback
Dependency Analysis Multi-language AST parsing, call graph construction, dependency graph building
Frontend Core FastAPI web app, background job queue, caching, Markdown rendering
Utils Shared FileManager for file and JSON I/O

Dependency Analysis Sub-modules

Module Description
Language Analyzers Per-language Tree-sitter AST analyzers (Python, JS, TS, Java, C#, C, C++, PHP)
Dependency Graph Building Graph construction from parsed AST data
AST and Dependency Parsing Low-level AST traversal and dependency extraction
Analysis Models Data models for analysis results
Analysis Core Core analysis service and call graph resolution
Core Models Foundational domain models (Node, CallRelationship, AnalysisResult)

Architecture Diagrams

Visual Mermaid diagrams are available in ./diagrams/architecture/. Key diagrams include:

  • README.mmd — Full system architecture and pipeline overview
  • cli-core.mmd — CLI Core component and flow diagrams
  • agent-orchestration.mmd — Agent lifecycle and tool injection diagrams
  • llm-services.mmd — LLM provider and fallback chain diagrams
  • documentation-generation.mmd — Documentation generation pipeline
  • dependency-analysis.mmd — Dependency analysis pipeline
  • frontend-core.mmd — Web app request and job lifecycle diagrams
  • language-analyzers.mmd — Language analyzer component diagrams
  • core-models.mmd — Domain model class diagrams
  • analysis-core.mmd — Analysis service flow diagrams

All diagram source files are located at ./diagrams/architecture/.

📖 Quick Links

Resource Link
Project README ../README.md
Contributing Guide ../CONTRIBUTING.md
License ../LICENSE.md
OpenMSP Community Slack Join here
Flamingo Platform flamingo.run
OpenFrame openframe.ai
GitHub Repository github.com/flamingo-stack/CodeWiki

Documentation generated by 🦩 Flamingo AI Technical Writer