This page describes the apache/hugegraph-doc repository: its purpose as the source for the Apache HugeGraph documentation website, its top-level structure, and the integration of its major systems. For details on the specific HugeGraph components covered in this repository, see HugeGraph Ecosystem. For details on the site's build configuration and toolchain, see Site Architecture.
apache/hugegraph-doc is the source code repository for the HugeGraph documentation website. It produces the static content served at hugegraph.apache.org. The repository is distinct from the core database engine; it contains Markdown content, Hugo templates, and the automation scripts required to maintain the site.
The site is built using Hugo Extended (specifically v0.102.3 in production) and the Docsy theme. It supports a bilingual structure (Chinese and English) and includes a Node.js-based toolchain for processing SCSS and rendering Mermaid diagrams.
Sources: README.md1-14 AGENTS.md5-8 NOTICE1-7
Diagram: From Source to Live Website
Sources: AGENTS.md82-88 README.md21-32 AGENTS.md38-53
The following table outlines the top-level directory structure and the role of key configuration files.
| Path | Type | Role |
|---|---|---|
content/cn/ | Directory | Chinese documentation (default language) |
content/en/ | Directory | English documentation (mirrors cn/ structure) |
themes/docsy/ | Git submodule | The Docsy Hugo theme; provides base layouts and logic |
assets/ | Directory | Custom SCSS, images, and web fonts |
layouts/ | Directory | Hugo template overrides for customizing Docsy |
static/ | Directory | Static assets (favicons, etc.) served without processing |
config.toml | File | Main Hugo configuration: menus, languages, and site metadata |
package.json | File | Node.js dependencies for PostCSS and Mermaid.js |
.nvmrc | File | Pins the Node.js runtime version for CI and local dev |
.editorconfig | File | Enforces consistent whitespace and encoding across the repo |
.asf.yaml | File | Configures ASF-specific repo settings and website publishing |
AGENTS.md | File | Guidance for AI coding assistants (Claude, Cursor, etc.) |
Sources: README.md40-60 AGENTS.md38-53 AGENTS.md68-73
The repository includes an AGENTS.md file designed to provide context and instructions for AI coding assistants. It covers project overview, common development commands, and specific requirements such as maintaining bilingual parity when editing content. Developers using tools like Claude Code, Cursor, or GitHub Copilot should refer to this file for optimized guidance.
Sources: AGENTS.md1-4 .gitignore21-31
All content and code in this repository are licensed under the Apache License 2.0 (LICENSE1-202). The NOTICE file (NOTICE1-8) records the copyright attribution:
Apache HugeGraph Documentation
Copyright 2022-2026 The Apache Software Foundation
The project was donated to the ASF by the original HugeGraph authors (copyright 2017-2021) and is managed under the Apache Software Foundation governance.
Sources: LICENSE1-10 NOTICE1-8
Diagram: Repository Entities and Dependencies
Sources: AGENTS.md38-88 README.md40-60 NOTICE1-7
| Topic | Page |
|---|---|
| Components documented here (Server, Store, PD, Computer, AI, Toolchain) | HugeGraph Ecosystem |
| Static site generator, theme, and Node.js pipeline | Site Architecture |
| Bilingual directory hierarchy and content types | Content Organization |
Detailed settings in config.toml and package.json | Build Configuration |
Local setup and hugo server usage | Local Development |
| Deployment and release validation workflows | CI/CD Pipelines |
| Contribution workflow and PR requirements | Pull Request Guidelines |
| ASF infrastructure settings and branch protection | Repository Configuration |