Skip to content

Latest commit

 

History

History
18 lines (17 loc) · 1.49 KB

INDEX.md

File metadata and controls

18 lines (17 loc) · 1.49 KB

Documentation Index

  • USAGE.md: install, configure, and use the CLI and MCP tools
  • COMMANDS.md: reference for the CLI commands and their exit codes, the 30 MCP tools, 5 MCP prompts, and skills
  • FAQ.md: how it compares to LSP, RAG, grep, and similar tools; when not to use it
  • FEATURES.md: release highlights by version
  • CHANGELOG.md: every change by release, with upgrade notes
  • GITHUB_ACTION.md: risk-scored PR review comments in GitHub Actions
  • CUSTOM_LANGUAGES.md: add a language through .code-review-graph/languages.toml
  • architecture.md: system design and data flow
  • schema.md: node and edge types, SQLite tables (including flows, communities, FTS5)
  • TROUBLESHOOTING.md: code-review-graph doctor, then common problems and fixes, including Windows/WSL
  • REPRODUCING.md: how every benchmark number was produced (pinned SHAs, seeded runs, tokenizer calibration)
  • ROADMAP.md: shipped and planned work
  • LEGAL.md: licence and privacy
  • LLM-OPTIMIZED-REFERENCE.md: compact reference shipped inside the package for MCP clients
  • CONTRIBUTING.md: development setup, branching model (staging → testing → main), release flow
  • RELEASING.md: the steps to cut a release, from the release branch to PyPI