docs: AGENTS/README & refactor server/toolchain docs#446
Merged
Conversation
Restructure and clarify repository documentation. AGENTS.md was rewritten and condensed into a practical agent/dev guide with development commands, prerequisites (Hugo Extended, Node.js v16+), content/structure overview, CI/CD notes, and troubleshooting tips. README.md was replaced with a bilingual (ZH/EN) homepage including a 3-step quickstart, repo layout, common commands, contributing requirements, contact info, and license. contribution.md was expanded with a PR checklist and clearer contribution steps (fork/branch/PR with screenshots). These changes improve onboarding and contribution workflows for the docs site.
dosubot
bot
added
the
size:L
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures and modernizes the documentation for the HugeGraph docs site to make local setup and contribution workflows clearer for both humans and AI tooling.
Changes:
- Rewrites
AGENTS.mdinto a concise, practical guide for AI coding assistants, covering project structure, dev commands, prerequisites, CI/CD, and troubleshooting. - Replaces
README.mdwith a bilingual (ZH/EN) entrypoint that focuses on 3-step local setup, repo layout, contribution requirements, common commands, and contact info. - Expands
contribution.mdwith a clear PR checklist and keeps the existing step-by-step local run / theme customization details as a deeper reference.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
AGENTS.md |
Condenses and reorganizes AI-agent guidance around dev commands, prerequisites, structure, CI/CD, and troubleshooting to align with the current Hugo/Node setup and workflows. |
README.md |
Replaces the previous product-centric README with a docs-repo-centric, bilingual quickstart and contribution overview that improves onboarding for docs contributors. |
contribution.md |
Adds a PR checklist and positions the file as a detailed reference, complementing the new README quickstart while retaining legacy setup and theme instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Bump documentation site version and update docs/configs to reflect HugeGraph 1.7.0 changes: update config.toml version to 1.7; add Version Change notices for Auth REST API in CN/EN; revise HugeGraph-Server quickstart (docker images, download/toolchain URLs) and add deprecation warnings for removed legacy backends (MySQL, PostgreSQL, Cassandra, ScyllaDB) in favor of 1.7 backends (RocksDB, HStore, HBase, Memory). Update default rest-server config docs: increase batch.max_* defaults, raise batch.max_write_ratio, set exception.allow_trace true, add log.slow_query_threshold, and add K8s / PD/Meta / Arthas configuration option sections.
dosubot
bot
added
size:XL
imbajin
changed the title
imbajin
changed the title
Add HugeGraph-Spark-Connector quick start docs (English and Chinese). Add a Configuration section to HugeGraph-Hubble docs (server settings and Gremlin query limits) in both languages. Update hugegraph-tools docs (EN/CN) to document new graph commands (graph-create, graph-clone, graph-drop), authentication backup/restore (auth-backup, auth-restore), --thread-num option for relevant commands, and minor heading/usage adjustments.
dosubot
bot
added
size:XXL
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Build with specific environment | ||
| HUGO_ENV="production" hugo --gc | ||
| ``` | ||
| - `config.toml` - Site-wide settings, language config, menu structure, version (currently 0.13) |
There was a problem hiding this comment.
config.toml is now configured with version = "1.7", but this note still states the version is "currently 0.13", which can mislead tooling or contributors relying on this guide. Please update the mentioned version here to match the actual value in config.toml so the documentation stays consistent.
Suggested change
| - `config.toml` - Site-wide settings, language config, menu structure, version (currently 0.13) | |
| - `config.toml` - Site-wide settings, language config, menu structure, version (currently 1.7) |
Comment on lines
141
to
+147
|
|
||
| ```bash | ||
| # download toolchain package, it includes loader + tool + hubble, please check the latest version (here is 1.5.0) | ||
| wget https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-toolchain-incubating-1.5.0.tar.gz | ||
| # download toolchain package, it includes loader + tool + hubble, please check the latest version (here is 1.7.0) | ||
| wget https://downloads.apache.org/incubator/hugegraph/1.7.0/apache-hugegraph-toolchain-incubating-1.7.0.tar.gz | ||
| tar zxf *hugegraph-*.tar.gz | ||
| # enter the tool's package | ||
| cd *hugegraph*/*tool* | ||
| cd *hugegraph*/*tool* |
There was a problem hiding this comment.
The fenced code block inside this <details> section has mismatched bash fences: there is an extra opening bash before the #### 3.4 heading and another bash before the download commands, which causes the heading to be rendered as code and can leave a code block unclosed. Please collapse this to a single fenced code block (e.g., move `#### 3.4` outside of the code block and keep only one bash fence around the shell commands) so the Markdown renders correctly.
VGalaxies
approved these changes
Jan 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restructure and clarify repository documentation. AGENTS.md was rewritten and condensed into a practical agent/dev guide with development commands, prerequisites (Hugo Extended, Node.js v16+), content/structure overview, CI/CD notes, and troubleshooting tips. README.md was replaced with a bilingual (ZH/EN) homepage including a 3-step quickstart, repo layout, common commands, contributing requirements, contact info, and license. contribution.md was expanded with a PR checklist and clearer contribution steps (fork/branch/PR with screenshots). These changes improve onboarding and contribution workflows for the docs site.