imbajin opened a new pull request, #3471: URL: https://github.com/apache/hugegraph/pull/3471
Mirrors [hugegraph/hugegraph#370](https://github.com/hugegraph/hugegraph/pull/370) 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 task-oriented product entry point focused on HugeGraph's database capabilities, deployment choices and ecosystem; keep TinkerPop/Gremlin as one compatibility path rather than the main product narrative. - Add `docs/README.md` as the canonical repository documentation index and define clear ownership between source docs, module docs, website docs, `AGENTS.md` and `.serena`. - Reduce the Helm README to installation, topology selection, common settings and operational boundaries, then add `helm/hugegraph/docs/README.md` to connect the detailed operations, distribution, RAG, SeaTunnel and Vermeer guides. - Consolidate `.serena` into three small navigation memories linked to authoritative docs and remove five duplicated/stale memory files. - Set Markdown editor guidance to logical paragraphs with a 160-character review guide and no automatic wrapping while typing. ## Documentation principles introduced - One canonical owner per topic; every durable page must be reachable from an index. - Describe current contracts and operational boundaries instead of implementation chronology. - Avoid durable PR links, commit hashes, temporary branches and copied version inventories. - Prefer explicit component names, paths, configuration keys and verification results for both human and LLM retrieval. ## Validation - Documentation-only change; no source, chart template or runtime configuration behavior changed. - Verified every new relative target against the repository tree through the GitHub API. - Reviewed the complete branch diff: 15 files changed, including five intentional stale-memory deletions. - The detailed existing API/runtime/Helm guides remain in place and are now linked from explicit entry points. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## Summary by CodeRabbit * **文档** * 精简项目主页与 Helm 部署指南，改为提供概览、常用操作示例和专题文档入口。 * 新增项目文档及 Helm 文档索引，说明内容归属、维护规范和常见阅读路径。 * 更新仓库导航与架构指引，帮助查找模块、构建和部署相关资料；移除部分旧版维护指南。 * **样式** * Markdown 文件的建议行宽调整为 160 个字符。 <!-- 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]
