imbajin opened a new pull request, #406: URL: https://github.com/apache/hugegraph-ai/pull/406
Mirrors [hugegraph/hugegraph-ai#99](https://github.com/hugegraph/hugegraph-ai/pull/99) from the existing source branch. Verification details below are reported by the source PR; ASF CI has not yet run for this pull request. ## Summary - Rework the root README into a module-selection and integration entry point for GraphRAG, the standalone LLM SDK, MCP, the Python client, graph ML and Vermeer. - Add `docs/README.md` as the canonical cross-module index for quality, testing, SDK architecture, release guidance and package-owned documentation. - Simplify `AGENTS.md` around package ownership, downstream validation and documentation boundaries instead of repeating quick starts and deployment instructions. - Add `.editorconfig` guidance for logical Markdown paragraphs, a 160-character review guide and no automatic wrapping while typing. - Replace the long `rules/README.md` onboarding/model-recommendation narrative with a concise optional workflow for genuinely complex or high-risk changes; small local fixes no longer inherit mandatory ceremony. ## Documentation principles introduced - Package READMEs own installation, public APIs, extras and compatibility. - `docs/` owns cross-module architecture, quality and release policy. - Durable documentation describes current contracts, failure boundaries and verification—not review history, execution logs, model recommendations, PR links or commit hashes. - Shared SDK and Python-client changes explicitly require affected `hugegraph-llm` or MCP caller validation. ## Validation - Documentation-only change; no Python package, dependency, Docker or runtime behavior changed. - Verified every referenced module and document against the repository tree and current workspace configuration. - Preserved the exact README quality-command contract enforced by `scripts/tests/test_developer_tooling.py`. - `HugeGraph AI CI` passes: release/CI policy tests, synchronized metadata checks, license headers and the final selected-check gate succeeded; unrelated runtime suites were skipped by the docs-only policy. - Reviewed the complete five-file diff after the CI-driven documentation corrections. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## Summary by CodeRabbit - **文档** - 重整项目首页,新增模块导航、组件关系、快速启动说明及开发检查和测试指引。 - 新增跨模块文档索引,明确各类资料的适用范围,并补充文档写作与变更检查清单。 - 更新协作指南,提供可按需选择的分阶段工作流程;旧版强制审批及阶段产出要求不再保留。 - 调整项目指南,梳理模块职责、验证要求和文档审查事项;部分旧有说明已移除。 - **开发配置** - 新增通用编辑器格式规则,涵盖换行、空格、缩进及文件末尾格式。 <!-- end of auto-generated comment: release notes by coderabbit.ai --> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
