# relay-knowledge English Documentation
The English and Chinese editions share the same six-volume taxonomy: user
workflows first, feature behavior second, then architecture specifications,
research notes, benchmark records, and verification records. Chapter sets may
differ only where this bookshelf or a volume cover maps the difference
explicitly; a matching volume does not imply a one-to-one chapter translation.
Directory responsibilities are fixed: `01-user-guide` is for executable user
workflows; `02-capabilities` describes implemented behavior only;
`03-architecture-specs` keeps hard contracts, interface boundaries, and forward
product requirements; `04-research` keeps dated research and gap analysis;
`05-benchmarks` stores benchmark and optimization records; `06-verification`
stores validation, audit, and documentation freshness records. Content files
inside numbered volumes use a two-digit chapter prefix; `README.md` files are
volume covers and count as chapter 0 when they appear in a reading path.
For release preparation, start with the root README, Chapter 1 installation
workflow, Chapter 19 installation/release architecture contract, and the latest
[documentation and self-iteration readiness record](06-verification/13-documentation-self-iteration-readiness-2026-08-18.md).
The [2026-06-05 audit](06-verification/11-documentation-release-readiness-2026-06-05.md)
remains a historical snapshot rather than evidence for the current worktree.
The Chinese edition currently includes several benchmark and verification
records that are intentionally listed below as Chinese-only until translated.
## Book 1: User Guide
- [Chapter 0: User Guide Overview](01-user-guide/README.md): install, CLI, knowledge graphs, code repository graphs, Web, agent access, resident service operation, background tasks, observability, troubleshooting, and advanced configuration.
- [Chapter 1: Installation and Runtime Directories](01-user-guide/01-install-and-runtime.md)
- [Chapter 2: CLI Basics](01-user-guide/02-cli-basics.md)
- [Chapter 3: CLI Command Reference](01-user-guide/03-cli-command-reference.md)
- [Chapter 4: Knowledge Graph](01-user-guide/04-knowledge-graph.md)
- [Chapter 5: Code Repository Graph Workflow](01-user-guide/05-code-repository-graph-workflow.md)
- [Chapter 6: Web Workspace](01-user-guide/06-web-workspace.md)
- [Chapter 7: MCP Agent Access](01-user-guide/07-mcp-agent-access.md)
- [Chapter 8: ACP Local Adapter](01-user-guide/08-acp-local-adapter.md)
- [Chapter 9: Service Deployment and Resident Operation](01-user-guide/09-resident-service.md)
- [Chapter 10: Workers, Proposals, and Audit](01-user-guide/10-workers-proposals-audit.md)
- [Chapter 11: Observability and Telemetry](01-user-guide/11-observability-and-telemetry.md)
- [Chapter 12: Advanced Configuration](01-user-guide/12-advanced-configuration.md)
- [Chapter 13: Operations and Troubleshooting](01-user-guide/13-operations-and-troubleshooting.md)
## Book 2: Capabilities
- [Chapter 0: Capabilities Overview](02-capabilities/README.md): implemented behavior, reading order, and status-language conventions.
- [Chapter 1: Capability Overview](02-capabilities/01-capability-overview.md)
- [Chapter 2: Local-first Runtime and CLI](02-capabilities/02-local-first-runtime-and-cli.md)
- [Chapter 3: Evidence and Graph Facts](02-capabilities/03-evidence-and-graph-facts.md)
- [Chapter 4: Query and Context Pack Basics](02-capabilities/04-query-and-context-pack-basics.md)
- [Chapter 5: Hybrid Retrieval Advantage](02-capabilities/05-hybrid-retrieval-advantage.md)
- [Chapter 6: Freshness and Index Recovery](02-capabilities/06-freshness-and-index-recovery.md)
- [Chapter 7: Multimodal Evidence Capability](02-capabilities/07-multimodal-evidence-capability.md)
- [Chapter 8: Code Repository Basics](02-capabilities/08-code-repository-basics.md)
- [Chapter 9: Code Graph Competitive Features](02-capabilities/09-code-graph-competitive-features.md)
- [Chapter 10: Code Impact and Reporting](02-capabilities/10-code-impact-and-reporting.md)
- [Chapter 11: Semantic/Vector Provider Backend](02-capabilities/11-semantic-vector-provider-backend.md)
- [Chapter 12: Web Workspace Capabilities](02-capabilities/12-web-workspace-capabilities.md)
- [Chapter 13: Agent Access Capabilities](02-capabilities/13-agent-access-capabilities.md)
- [Chapter 14: Operations and Worker Capabilities](02-capabilities/14-operations-and-worker-capabilities.md)
- [Chapter 15: Evaluation and Quality Gates](02-capabilities/15-evaluation-and-quality-gates.md)
## Book 3: Architecture Specifications
- [Chapter 0: Architecture Specifications Overview](03-architecture-specs/README.md): normative contracts, reading order, and contract interpretation.
- [Chapter 1: Architecture Vision and Algorithm Map](03-architecture-specs/01-architecture-vision-and-algorithm-map.md)
- [Chapter 2: Engineering Hard Constraints](03-architecture-specs/02-engineering-hard-constraints.md)
- [Chapter 3: Foundational Runtime](03-architecture-specs/03-foundational-runtime.md)
- [Chapter 4: Source Scope Model](03-architecture-specs/04-source-scope-model.md)
- [Chapter 5: Multimodal Evidence Ingestion](03-architecture-specs/05-multimodal-evidence-ingestion.md)
- [Chapter 6: Graph Fact Model and Versioning](03-architecture-specs/06-graph-fact-model-and-versioning.md)
- [Chapter 7: Storage Engine and Mutation Log](03-architecture-specs/07-storage-engine-and-mutation-log.md)
- [Chapter 8: Derived Indexes and Freshness](03-architecture-specs/08-derived-indexes-and-freshness.md)
- [Chapter 9: Hybrid Retrieval and Context Packing](03-architecture-specs/09-hybrid-retrieval-and-context-packing.md)
- [Chapter 10: Semantic/Vector Provider Architecture](03-architecture-specs/10-semantic-vector-provider-architecture.md)
- [Chapter 11: Code Knowledge Graph Model](03-architecture-specs/11-code-knowledge-graph-model.md)
- [Chapter 12: Tree-sitter Extraction and Incremental Indexing](03-architecture-specs/12-tree-sitter-extraction-and-incremental-indexing.md)
- [Chapter 13: Code Retrieval Ranking and Impact Analysis](03-architecture-specs/13-code-retrieval-ranking-and-impact-analysis.md)
- [Chapter 14: Open Agent Runtime Adapter Architecture](03-architecture-specs/14-open-agent-runtime-adapter-architecture.md)
- [Chapter 15: Resident Agent Graph Access Protocol](03-architecture-specs/15-resident-agent-graph-access-protocol.md)
- [Chapter 16: Unified API and Interface Architecture](03-architecture-specs/16-unified-api-and-interface-architecture.md)
- [Chapter 17: Background Service, Recovery, and Self-Healing](03-architecture-specs/17-background-service-recovery-and-self-healing.md)
- [Chapter 18: Observability, Diagnostics, and SLO](03-architecture-specs/18-observability-diagnostics-and-slo.md)
- [Chapter 19: Installation, Release, and Upgrade](03-architecture-specs/19-installation-release-and-upgrade.md)
- [Chapter 20: Multi-Repository Code Graph Overlay](03-architecture-specs/20-multi-repository-code-graph-overlay.md)
- [Chapter 21: Software Global Domain Modeling Architecture](03-architecture-specs/21-software-global-domain-modeling.md)
- [Chapter 22: Service Deployment, Control Plane, and Data Plane](03-architecture-specs/22-service-deployment-control-data-plane.md)
- [Chapter 24: Code-Map-Backed Knowledge Development Loop](03-architecture-specs/24-code-map-backed-knowledge-development-loop.md)
- [Chapter 25: Code Index Retention](03-architecture-specs/25-code-index-retention.md)
- [Chapter 26: Git Commit + Knowledge Development Philosophy and Iteration Loop](03-architecture-specs/26-git-commit-knowledge-development-loop.md)
- [Chapter 27: Business Knowledge to Technical Graph Mapping](03-architecture-specs/27-business-knowledge-technical-mapping.md)
## Book 4: Research
- [Chapter 0: Research Overview](04-research/README.md): research sources, goals, competitive positioning, scenario fit, and forward roadmap.
- [Chapter 1: Industry Capability Snapshot 2026](04-research/01-industry-capability-snapshot-2026.md)
- [Chapter 2: Knowledge Graph Research Summary](04-research/02-knowledge-graph-research.md)
- [Chapter 3: arXiv Knowledge Graph Paper Insights](04-research/03-arxiv-knowledge-graph-paper-insights.md)
- [Chapter 4: ai-knowledge-graph Reference Analysis](04-research/04-ai-knowledge-graph-reference-analysis.md)
- [Chapter 5: Code Repository Tree-sitter Retrieval Research](04-research/05-code-repository-tree-sitter-retrieval-research.md)
- [Chapter 6: Agent Protocol Graph Retrieval Research](04-research/06-agent-protocol-graph-retrieval-research.md)
- [Chapter 7: relay-knowledge Implementation Reference](04-research/07-relay-knowledge-implementation-reference.md)
- [Chapter 8: Competitive, High-Performance, and Local File Retrieval Research 2026](04-research/08-competitive-performance-research-2026.md)
- [Chapter 9: GitNexus Feature and UI Implementation Research 2026](04-research/09-gitnexus-reference-analysis-2026.md)
- [Chapter 10: Software Global Domain Modeling Research 2026](04-research/10-software-global-domain-modeling-research-2026.md)
- [Chapter 11: Software Global Modeling, CodeGraph, and Search Everything Comparison 2026](04-research/11-software-global-codegraph-search-everything-comparison-2026.md)
- [Chapter 12: Hierarchical BM25 Analysis 2026](04-research/12-hierarchical-bm25-analysis-2026.md)
## Appendix A: Benchmarks
- [Appendix A.0: Benchmark and Evaluation Records](05-benchmarks/README.md): dated evidence boundaries, result index, and safe comparison rules.
- [Appendix A.1: relay-teams Baseline 2026-05-14](05-benchmarks/01-relay-teams-baseline-2026-05-14.md)
- [Appendix A.2: relay-teams Optimization Issues 2026-05-14](05-benchmarks/02-relay-teams-optimization-issues-2026-05-14.md)
- [Appendix A.3: relay-teams Optimization Study 2026-05-14](05-benchmarks/03-relay-teams-optimization-study-2026-05-14.md)
- [Appendix A.4: Self-Iteration Optimization Status Ledger](05-benchmarks/04-self-iteration-accepted-optimizations.md)
- [Appendix A.5: Competitive and High-Performance Benchmark Targets 2026-05-17](05-benchmarks/05-competitive-performance-benchmark-targets-2026-05-17.md)
- [Appendix A.6: C/C++ Syntax Self-Iteration Evaluation Set 2026-05-20](05-benchmarks/06-c-cpp-syntax-self-iteration-evaluation.md)
- [Appendix A.7: Multilingual Syntax Self-Iteration Evaluation Set 2026-05-21](05-benchmarks/07-multilingual-syntax-self-iteration-evaluation.md)
Chinese-only benchmark addenda pending English translation:
[Appendix A.8](../zh/05-benchmarks/08-code-index-fact-versioning.md),
[Appendix A.9](../zh/05-benchmarks/09-code-query-ranking-foundational.md), and
[Appendix A.10](../zh/05-benchmarks/10-profile-all-performance-source-surface-2026-06-04.md).
The detailed historical runs split from Appendix A.4 are also Chinese-only;
their entry point is the [Chinese archive index](../zh/05-benchmarks/archive/README.md).
## Appendix B: Verification
- [Appendix B.0: Verification Records](06-verification/README.md): dated audit index and evidence rules.
- [Appendix B.1: relay-teams E2E Verification 2026-05-14](06-verification/01-relay-teams-e2e-2026-05-14.md)
- [Appendix B.2: Documentation Content Audit 2026-05-14](06-verification/02-documentation-content-audit-2026-05-14.md): current documentation status, refreshed gaps, and open productization work.
- [Appendix B.3: relay-teams Retrieval Accuracy 2026-05-15](../zh/06-verification/03-code-graph-retrieval-accuracy-relay-teams-2026-05-15.md) (Chinese only)
- [Appendix B.4: Linux Retrieval Accuracy 2026-05-15](../zh/06-verification/04-code-graph-retrieval-accuracy-linux-2026-05-15.md) (Chinese only)
- [Appendix B.5: Documentation Book Structure Audit 2026-05-17](06-verification/05-documentation-book-structure-audit-2026-05-17.md): directory responsibilities, closed capability status, and bookshelf index refresh.
- [Appendix B.6: Documentation Content Refresh Audit 2026-05-17](06-verification/06-documentation-content-refresh-audit-2026-05-17.md): documentation sync record for the code retrieval self-iteration commits.
- [Appendix B.7: Grep Fallback Documentation Refresh Audit 2026-05-22](06-verification/07-grep-fallback-documentation-refresh-2026-05-22.md): chapter sync record for code retrieval exact-text fallback.
- [Appendix B.8: Software Global Modeling Documentation Refresh Audit 2026-05-28](06-verification/08-software-global-modeling-documentation-refresh-2026-05-28.md): verification record for the software global modeling research and architecture archive.
- [Appendix B.9: Software Global, CodeGraph, and Search Everything Research Documentation Refresh Audit 2026-05-31](06-verification/09-software-global-codegraph-search-everything-research-2026-05-31.md): chapter 11 research and bookshelf index sync record.
- [Appendix B.10: Service Deployment, Control Plane, and Data Plane Documentation Refresh Audit 2026-06-04](06-verification/10-service-deployment-control-data-plane-2026-06-04.md): issue #250 service deployment plan and architecture index sync record.
- [Appendix B.11: Documentation Release Readiness Audit 2026-06-05](06-verification/11-documentation-release-readiness-2026-06-05.md): release navigation, file inventory, local link checking, and documentation-only change boundaries.
- [Appendix B.12: Graph Database, Knowledge Graph, and CodeGraph Deep Research Archive 2026-06-05](06-verification/12-graph-database-codegraph-deep-research-archive-2026-06-05.md): arXiv, X.com, Reddit, and open-source source ledger, research artifacts, competitive feature issues, and validation state archive.
- [Appendix B.13: Documentation and Self-Iteration Readiness Verification 2026-08-18](06-verification/13-documentation-self-iteration-readiness-2026-08-18.md): current confirmed Rust/package/Web-build/runtime/browser/coverage evidence, an accepted focused-fast performance report, the local `--with-deps` setup limitation, pending exhaustive/Kubernetes accuracy evidence, and the failed Kubernetes 210-second performance rail.
Appendix B keeps one chronological identity across both editions. Entries B.3
and B.4 therefore stay in sequence while their English translations are pending.