Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 2.21 KB

File metadata and controls

33 lines (29 loc) · 2.21 KB

Guide

Documentation index for code-context-graph.

For LLM-agent workflows, start natural-language code exploration from the generated-docs path: use search_docs to find relevant docs, then get_doc_content to read one. Treat these as an evidence-driven narrowing layer, not a Top1 search engine: use the small file-level candidates to choose the shortest route into docs or graph tools.

The browser Wiki is served by ccg-server when --wiki-dir points at built React assets. It prefers the graph database for presentation, uses wiki-index.json as a compatibility tree snapshot, and uses /wiki/api/graph for the visual graph tab. Runtime documentation search uses DB-backed graph and annotation evidence. Use the Wiki when a human developer needs to browse docs, inspect annotation-rich symbol cards, collect Context Tray Markdown, or visually explore graph edges.

Document Description
CLI Reference Full CLI commands, options, and configuration file (.ccg.yaml)
Lint Detailed ccg lint category reference, interpretation guide, and CI usage
MCP Tools 18 MCP tools, agent skills, evidence-first routing, AI-driven annotation
Annotations Custom annotation system — tags, examples, and search quality
Webhook GitHub / Gitea webhook sync, branch filtering, graceful shutdown
Docker Docker image build, MCP server setup, Wiki UI deployment, PostgreSQL integration
Operations Deployment profiles, database choice, readiness, webhook operations, troubleshooting
Runtime Layout ccg, ccg-server, Wiki serving, and shared ccg-core ownership boundaries
Architecture System architecture, data flow, DB schema
Development Build, test, integration test (Gitea + PostgreSQL)
Large Build Performance Measured full-build bottlenecks, bounded concurrency, and import-file indexing
Namespace Migration Default namespace change and migration guide
CLAUDE.md Guide CLAUDE.md template for projects using CCG