This page describes the apache/hugegraph-doc repository: its role, what it produces, the top-level structure of its files, and how its major systems fit together. For details on the HugeGraph components whose documentation lives here, see HugeGraph Ecosystem. For the site's build configuration and toolchain, see Site Architecture.
apache/hugegraph-doc is the source repository for the official Apache HugeGraph documentation website, published at hugegraph.apache.org. It is not the graph database codebase itself — it contains only documentation content and the tooling needed to build and deploy it as a static website.
The repository uses Hugo Extended as its static site generator, the Docsy theme (included as a git submodule under themes/docsy/), and a Node.js pipeline for CSS processing and Mermaid diagram rendering. Changes pushed to the master branch trigger an automated GitHub Actions workflow that builds the site and deploys it to the asf-site branch, which Apache's infrastructure serves as the live website.
Sources: README.md1-14 AGENTS.md1-8 NOTICE1-7
Diagram: From Source to Live Website
Sources: AGENTS.md82-88 README.md21-32
The table below maps each top-level entry to its role in the project.
| Path | Type | Role |
|---|---|---|
content/cn/ | Directory | Chinese documentation (Hugo default language) |
content/en/ | Directory | English documentation (parallel structure to cn/) |
themes/docsy/ | Git submodule | Docsy Hugo theme; provides base layouts, CSS, JS |
assets/ | Directory | Custom fonts, images, SCSS overrides |
layouts/ | Directory | Hugo template overrides on top of Docsy |
static/ | Directory | Files served verbatim (no processing) |
config.toml | File | Site-wide Hugo settings, language config, menu, versioning |
package.json | File | Node.js dependencies: postcss, autoprefixer, mermaid |
.nvmrc | File | Pins Node.js LTS version for consistent CI/local parity |
.editorconfig | File | Enforces UTF-8, LF line endings, indentation rules |
.asf.yaml | File | Controls GitHub repo settings and ASF web publishing |
.github/workflows/ | Directory | GitHub Actions: site deployment, release validation, maintenance |
LICENSE | File | Apache License 2.0 |
NOTICE | File | ASF required copyright attribution |
Sources: README.md40-60 AGENTS.md38-53
Diagram: File Entities and Their Interactions
Sources: AGENTS.md68-88 README.md55-60
The repository and its content are licensed under the Apache License 2.0 (LICENSE1-202). The NOTICE file (NOTICE1-7) records the canonical attribution:
Apache HugeGraph Documentation (incubating)
Copyright 2022-2025 The Apache Software Foundation
The initial codebase was donated to the ASF by HugeGraph Authors (copyright 2017–2021). The project operates under Apache's incubating governance model; this is reflected in the (incubating) label in the NOTICE file and in the Apache Software Foundation infrastructure used for deployment (the asf-site branch, ASF mailing lists, SVN artifact distribution).
Sources: NOTICE1-7 LICENSE1-10
Diagram: Systems Map — Code Entities and Their Dependencies
Sources: AGENTS.md38-88 README.md40-60 NOTICE1-7
| Topic | Page |
|---|---|
| HugeGraph components documented here (Server, Store, PD, Computer, AI, Toolchain) | HugeGraph Ecosystem |
| Hugo + Docsy + Node.js build pipeline detail | Site Architecture |
| Bilingual content directory structure | Content Organization |
config.toml, package.json, .nvmrc, .editorconfig detail | Build Configuration |
| Running the site locally | Local Development |
| GitHub Actions workflows | CI/CD Pipelines |
| PR process and branch protection rules | Pull Request Guidelines |
.asf.yaml configuration reference | Repository Configuration |
Refresh this wiki
This wiki was recently refreshed. Please wait 2 days to refresh again.
