This directory indexes cross-module architecture, quality and release documentation. Package installation and API usage belong in the nearest module README; long-form user tutorials belong on the HugeGraph website.
| Task | Document |
|---|---|
| Choose a module and run the main application | Root README |
| Understand CI selection and validation tiers | quality/ci.md |
| Understand test categories | quality/test-taxonomy.md |
| Run integration tests with HugeGraph | quality/hugegraph-integration.md |
| Maintain the coverage ratchet | quality/coverage-ratchet.md |
| Understand SDK ownership and extension boundaries | sdk/architecture.md |
| Prepare a release | releasing.md |
| Work on GraphRAG, extraction or the application API | hugegraph-llm/ |
| Integrate the standalone SDK | hugegraph-llm-sdk/ |
| Configure MCP clients and toolsets | hugegraph-mcp/ |
| Use the Python client | hugegraph-python-client/ |
| Follow the staged workflow for complex AI-assisted changes | rules/README.md |
pyproject.toml, container configuration and CI workflows define current executable behavior.AGENTS.md and rules/ guide development work; they should link to product documentation rather than restating it.When a shared package changes, document the stable ownership boundary here and keep detailed API examples beside that package. For example, hugegraph-llm-sdk owns reusable schema/extraction contracts while hugegraph-llm owns application orchestration and presentation.
pyproject.toml. Repeat a version in prose only when it is itself a compatibility contract.