wehub-resource-sync
16 lines
1.1 KiB
Markdown
16 lines
1.1 KiB
Markdown
# Documentation Index
|
|
|
|
- [USAGE.md](USAGE.md) -- How to install and use
|
|
- [FAQ.md](FAQ.md) -- How it compares to LSP, RAG, grep, and similar tools; when not to use it
|
|
- [FEATURES.md](FEATURES.md) -- What's included, changelog
|
|
- [COMMANDS.md](COMMANDS.md) -- All 30 MCP tools, 5 MCP prompts, skills, and CLI commands
|
|
- [GITHUB_ACTION.md](GITHUB_ACTION.md) -- Risk-scored PR review comments via GitHub Actions
|
|
- [CUSTOM_LANGUAGES.md](CUSTOM_LANGUAGES.md) -- Bring your own language via `.code-review-graph/languages.toml`
|
|
- [LLM-OPTIMIZED-REFERENCE.md](LLM-OPTIMIZED-REFERENCE.md) -- Token-optimized reference for MCP-capable AI coding agents
|
|
- [architecture.md](architecture.md) -- System design and data flow
|
|
- [schema.md](schema.md) -- Graph node/edge schema, SQLite tables (including flows, communities, FTS5)
|
|
- [TROUBLESHOOTING.md](TROUBLESHOOTING.md) -- Common issues and fixes (including Windows/WSL)
|
|
- [REPRODUCING.md](REPRODUCING.md) -- Reproducing every benchmark number (pinned SHAs, seeded runs, tokenizer calibration)
|
|
- [ROADMAP.md](ROADMAP.md) -- Shipped and planned features
|
|
- [LEGAL.md](LEGAL.md) -- License and privacy
|