[imbajin]

Mirrors hugegraph/hugegraph#370 from the existing source branch. Verification details below are reported by the source PR; See this pull request’s checks for the current ASF CI status.

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.

Summary by CodeRabbit

• 文档
  • 精简项目主页与 Helm 部署指南，改为提供概览、常用操作示例和专题文档入口。
  • 新增项目文档及 Helm 文档索引，说明内容归属、维护规范和常见阅读路径。
  • 更新仓库导航与架构指引，帮助查找模块、构建和部署相关资料；移除部分旧版维护指南。
• 样式
  • Markdown 文件的建议行宽调整为 160 个字符。

[bitflicker64]

Blocking: yes. Summary: removing the Helm README sections Modes and entry points and Server service identity breaks inbound links from docs/seatunnel.md, docs/vermeer.md and docker/README.md, which now point at rules no page states. The quick start wait loop also closes an interactive shell on timeout.

[imbajin]

Follow-up review of cf29756 found one remaining shell boundary: the timeout branch now preserves an interactive shell, but break leaves the loop with exit status 0 even when readiness failed. I am adjusting the example so a timeout is reported as failure without terminating the interactive shell.

[imbajin]

Follow-up fixed in 18942c0: Docker startup failure and readiness timeout return a nonzero status from a subshell, without exiting a normal interactive shell. Each curl probe has a two-second timeout. Success, timeout, startup failure and a hanging socket were simulated locally; Docker itself was not started.

[imbajin]

A further documentation check found that global.imageRegistry does not rewrite every component image reference: the chart helper preserves references that already contain a qualified registry host. The current wording could mislead private-registry deployments. I will clarify the qualification rule and component-level override.

[imbajin]

Follow-up fixed in f6ea667: the Helm README now states that global.imageRegistry prefixes only unqualified references, while qualified component repositories and wait images remain unchanged. helm template was checked with unqualified references, ghcr.io and localhost:5000 references, and a qualified wait image.

[imbajin]

Review follow-up: restored homepages

Reviewed head 2538e9a40f684ae4be0ba229187b0bf27e0125ec against the preceding PR revision, focusing on the root and Helm READMEs. The earlier multi-reviewer full-PR score was 9.4/10 at an earlier head; this follow-up does not claim a fresh full review of all 268 files.

README follow-up score: 10/10. No remaining actionable findings were identified after correcting the readiness check, version examples, diagram labels, network-policy prerequisites, and HTTP/TLS guidance.

Validation included local link and heading checks, shell syntax and simulated readiness success/failure cases, plus Helm lint and template checks. Docker and Kubernetes deployment were not run against a live environment.

[bitflicker64]

Blocking: no. Score: 9/10. Summary: relative links, anchors and inbound links into the Helm README resolve at this head, and the build-from-source tarball path matches hugegraph-dist. Both earlier review comments are fixed.