[Task] code-doc sync before 1.8.0

[imbajin]

Release 1.8.0 gate

Update (2026-09-18): PR #492 was merged as 58b99a1. It completes the HugeGraph, AI, and Computer / Vermeer documentation items below. The Toolchain item and this release gate remain open.

• [P1] Audit all unmerged PRs intended for the 1.8.0 release and synchronize their user-facing documentation before the release branch is cut.
  • TODO steps:
    • Enumerate open and unmerged PRs labeled or otherwise identified as 1.8.0 release candidates.
    • Check each PR for user-visible behavior, configuration, API, CLI, deployment, or compatibility changes.
    • Map every documentation-impacting PR to the affected Chinese and English pages.
    • Update/add the docs and cross-link the PR or issue when the change is merged.
    • Record the mapping and verification status in this issue.
  • Evidence: PR doc: fix Computer/Vermeer examples and improve AI/Server guides #492 is now merged and completes the tracked documentation-sync items below; this issue still does not track the still-unmerged PRs intended for 1.8.0.
  • Impact: Release notes and user guides can remain incomplete for changes that are already merged or are about to be released.
  • Recommendation: Keep this gate open until the audit and mapping are complete.
  • Acceptance: Every relevant unmerged 1.8.0 PR has a documented impact assessment, an owner, and a verified CN/EN documentation update or an explicit no-docs-needed decision.

HugeGraph

• [P2] Document the current Server startup timeout setting in the Docker guide.

  • TODO:
    • Add HG_SERVER_STARTUP_TIMEOUT_S, default 120, valid range 1–86400, and failure behavior to the Chinese and English guides.
    • Add Docker/Compose examples and explain the distinction from the health check.
  • Completed by PR #492, which updates both language versions.
  • Acceptance: A user can find the variable, understand its default/range/failure behavior, and run the example without guessing.

• [P2] Add existing backend config pages to the Server configuration index.

  • TODO:
    • Add HBase, HStore, and RocksDB configuration links to the Chinese and English indexes.
    • Keep the links aligned with the existing configuration-page naming and navigation structure.
  • Completed by PR #492, which updates both language versions.
  • Acceptance: The Server configuration indexes expose the existing backend configuration pages in both languages.

Toolchain

• [P2] Remove or implement Kafka skipped_line option so docs and runtime behavior agree.
  • TODO:
    • Decide whether skipped_line is supported, deprecated, or invalid.
    • If supported, document the semantics and add/verify coverage.
    • If unsupported, remove it from the guide and add validation or migration guidance as needed.
    • Update both Chinese and English pages and cross-link the implementation PR.
  • Location: Kafka source guide and its Chinese counterpart.
  • Evidence: The documented option and the implementation behavior still need to be reconciled.
  • Impact: Users may configure an option that is ignored or misunderstand the loader's behavior.
  • Acceptance: The docs describe the actual behavior, with a verified example or explicit removal/migration guidance in both languages.

AI

• [P3] Add Vermeer Python Client page to AI quick-start follow-up links.

  • TODO:
    • Add the English Vermeer Python Client link.
    • Add the Chinese Vermeer Python Client link.
  • Completed by PR #492, which updates both AI quick-start pages.
  • Acceptance: Users following either quick-start page can reach the corresponding Vermeer Python Client documentation.

• [P1] Make the Vermeer Python Client example actually wait for task completion.

  • TODO:
    • Replace the single status read with bounded polling.
    • Handle terminal success and failure states and show a clear timeout/failure message.
    • Keep the Chinese and English examples behaviorally identical.
  • Completed by PR #492, which adds bounded polling and failure handling to both examples.
  • Acceptance: A copied example waits for completion, exits on success/failure, and cannot poll forever.

Computer / Vermeer

• [P1] Update Computer quick start to current graph-space REST paths.

  • TODO:
    • Replace the read mode URL in both languages with /graphspaces/DEFAULT/graphs/hugegraph/graph_read_mode.
    • Replace the vertex query URL in both languages with /graphspaces/DEFAULT/graphs/hugegraph/graph/vertices.
    • Re-run the examples against the documented endpoint shape.
  • Completed by PR #492, which updates the Computer examples in both languages.
  • Acceptance: The documented read-mode and vertex-query examples use the current graph-space paths and are runnable.

• [P1] Align documented Vermeer master HTTP port with the runnable deployment.

  • TODO:
    • Use HTTP port 6688 as the default, or explicitly map 8688 if that remains the documented port.
    • Update the Chinese and English REST examples.
    • Update the Python client example/configuration.
    • Add a runnable Docker/curl verification example.
  • Completed by PR #492, which aligns the HTTP port at 6688, documents gRPC on 6689, and adds Docker/curl verification in both languages.
  • Acceptance: A fresh deployment and the documented REST/Python examples use the same reachable port and protocol.