BREAKING CHANGE: graduate as TLP & refactor a string of docs#447
Merged
BREAKING CHANGE: graduate as TLP & refactor a string of docs#447
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.
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.
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.
Add comprehensive HugeGraph-AI documentation and update quickstart content. New files added (Chinese & English): config-reference.md (full configuration reference), hugegraph-ml.md (HugeGraph-ML overview, algorithms and examples), and rest-api.md (REST API reference including RAG and Text2Gremlin endpoints). Updated pages: _index.md (feature list and v1.5.0 highlights such as Text2Gremlin, multi-model vectors, bilingual prompts, LiteLLM support, enhanced rerankers), hugegraph-llm.md (LLM provider/LiteLLM, reranker and Text2Gremlin usage), and quick_start.md (language switching / bilingual prompt guide). Also tightened environment requirements (Python 3.10+, uv 0.7+, HugeGraph 1.5+) and updated ML algorithm count/details to 21. These changes expand docs for deploying and integrating LLM, Text2Gremlin, ML workflows and REST APIs.
Rewrite and restructure the Computer configuration documentation in both Chinese and English. The changes replace the old flat option tables with organized sections (Basics, Algorithm, Input, Snapshot/Storage, Worker/Master, I/O/Output, Network/Transport, Storage, BSP, Performance, System-managed, K8s Operator, KubeDriver and CRD). Added clear default-value semantics, examples for local and MinIO snapshots, notes about system-managed options (do not modify), and more explanatory text for many options. Also updated related CRD/KubeDriver fields formatting and clarified operator environment variable mapping. Minor related updates applied to the quickstart computing hugegraph-computer page.
dosubot
bot
added
the
size:XXL
|
Related Documentation No published documentation to review for changes on this repository. Write your first living document How did I do? Any feedback? |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for HugeGraph AI and Computer components to the official documentation site. The documentation covers REST APIs, configuration references, machine learning capabilities, and troubleshooting guides in both English and Chinese.
Changes:
- Added REST API reference documentation for HugeGraph-LLM with detailed endpoint specifications
- Added configuration reference documentation covering LLM providers, rerankers, and deployment options
- Added HugeGraph-ML documentation detailing 21 implemented graph machine learning algorithms
- Enhanced HugeGraph-Computer documentation with detailed configuration options and troubleshooting guides
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| content/en/docs/quickstart/hugegraph-ai/rest-api.md | New comprehensive REST API reference for RAG and Text2Gremlin endpoints |
| content/en/docs/quickstart/hugegraph-ai/config-reference.md | New configuration reference covering all HugeGraph-LLM settings |
| content/en/docs/quickstart/hugegraph-ai/hugegraph-ml.md | New documentation for 21 graph ML algorithms with examples |
| content/en/docs/quickstart/hugegraph-ai/hugegraph-llm.md | Enhanced with LLM provider configuration sections |
| content/en/docs/quickstart/hugegraph-ai/quick_start.md | Added language switching documentation (v1.5.0+) |
| content/en/docs/quickstart/hugegraph-ai/_index.md | Updated with v1.5.0 features and enhanced algorithm list |
| content/en/docs/quickstart/computing/hugegraph-computer.md | Significantly enhanced with configuration examples, troubleshooting, and K8s deployment details |
| content/en/docs/config/config-computer.md | Restructured with detailed categorization and system-managed configuration warnings |
| content/cn/docs/quickstart/hugegraph-ai/* | Chinese translations of all above English documentation |
| content/cn/docs/config/config-computer.md | Chinese translation of computer configuration reference |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Change repository links from incubator to apache/hugegraph and apache/hugegraph-doc in config and many docs; update Chinese homepage and docs with refreshed wording (add AI/LLM, features blocks, revised introductions and CTAs); adjust multiple changelog weights and fix numerous internal/repo links and examples to reflect project rename and content improvements.
Add description frontmatter to many REST API docs (Chinese and English) to provide concise summaries for each API page. Update quickstart index pages (computing, hugegraph‑ai, toolchain) to recommend DeepWiki with direct links and add GitHub access links. Revise CN FAQ backend storage guidance to describe single-node (RocksDB) vs distributed (HStore) deployment, recommend selection by scale, and note deprecation of Cassandra/HBase/MySQL in later versions.
Revise configuration documentation for both CN and EN sites: update page titles and linkTitle fields for config guide and options, enrich the config index pages with Server configuration overview and links (including auth/HTTPS), and move/rename the Computer config page from config/ to quickstart/computing/ with updated title, linkTitle and weight. Also adjust wording about distributed deployment scale (changed from "100GB+" to "< 1000TB") in FAQ and introduction pages for both languages.
dosubot
bot
added
size:L
Pengzna
previously approved these changes
Feb 2, 2026
Rename config guide and reference titles (English & Chinese) to "Server Startup Guide" and "Server Complete Configuration Manual"; reorganize config-option pages by converting optional/config blocks (K8s, Arthas, RPC server, HBase, Cassandra/ScyllaDB, MySQL/PostgreSQL) into collapsible <details> sections and group deprecated backends under a "≤ 1.5 Version Config (Legacy)" section. Also adjust index bullets ordering/labels. These changes improve readability and clearly mark legacy backend configs.
imbajin
changed the title
Pengzna
approved these changes
Feb 2, 2026
github-actions bot
pushed a commit
that referenced
this pull request
Feb 2, 2026
* docs: AGENTS.md, README.md, contribution.md 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. * Update README.md * server: update docs and configs for HugeGraph 1.7.0 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. * toolchain: add Spark connector and update Hubble/Tools 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. * AI: Add HugeGraph-AI docs and quickstart updates Add comprehensive HugeGraph-AI documentation and update quickstart content. New files added (Chinese & English): config-reference.md (full configuration reference), hugegraph-ml.md (HugeGraph-ML overview, algorithms and examples), and rest-api.md (REST API reference including RAG and Text2Gremlin endpoints). Updated pages: _index.md (feature list and v1.5.0 highlights such as Text2Gremlin, multi-model vectors, bilingual prompts, LiteLLM support, enhanced rerankers), hugegraph-llm.md (LLM provider/LiteLLM, reranker and Text2Gremlin usage), and quick_start.md (language switching / bilingual prompt guide). Also tightened environment requirements (Python 3.10+, uv 0.7+, HugeGraph 1.5+) and updated ML algorithm count/details to 21. These changes expand docs for deploying and integrating LLM, Text2Gremlin, ML workflows and REST APIs. * Revise and expand Computer config docs (CN/EN) Rewrite and restructure the Computer configuration documentation in both Chinese and English. The changes replace the old flat option tables with organized sections (Basics, Algorithm, Input, Snapshot/Storage, Worker/Master, I/O/Output, Network/Transport, Storage, BSP, Performance, System-managed, K8s Operator, KubeDriver and CRD). Added clear default-value semantics, examples for local and MinIO snapshots, notes about system-managed options (do not modify), and more explanatory text for many options. Also updated related CRD/KubeDriver fields formatting and clarified operator environment variable mapping. Minor related updates applied to the quickstart computing hugegraph-computer page. * BREAKING CHANGE: update docs links and Chinese content Change repository links from incubator to apache/hugegraph and apache/hugegraph-doc in config and many docs; update Chinese homepage and docs with refreshed wording (add AI/LLM, features blocks, revised introductions and CTAs); adjust multiple changelog weights and fix numerous internal/repo links and examples to reflect project rename and content improvements. * Add API descriptions and update quickstart links Add description frontmatter to many REST API docs (Chinese and English) to provide concise summaries for each API page. Update quickstart index pages (computing, hugegraph‑ai, toolchain) to recommend DeepWiki with direct links and add GitHub access links. Revise CN FAQ backend storage guidance to describe single-node (RocksDB) vs distributed (HStore) deployment, recommend selection by scale, and note deprecation of Cassandra/HBase/MySQL in later versions. * Update config docs titles and layout Revise configuration documentation for both CN and EN sites: update page titles and linkTitle fields for config guide and options, enrich the config index pages with Server configuration overview and links (including auth/HTTPS), and move/rename the Computer config page from config/ to quickstart/computing/ with updated title, linkTitle and weight. Also adjust wording about distributed deployment scale (changed from "100GB+" to "< 1000TB") in FAQ and introduction pages for both languages. * Update config docs: titles and reformat sections Rename config guide and reference titles (English & Chinese) to "Server Startup Guide" and "Server Complete Configuration Manual"; reorganize config-option pages by converting optional/config blocks (K8s, Arthas, RPC server, HBase, Cassandra/ScyllaDB, MySQL/PostgreSQL) into collapsible <details> sections and group deprecated backends under a "≤ 1.5 Version Config (Legacy)" section. Also adjust index bullets ordering/labels. These changes improve readability and clearly mark legacy backend configs. 655c3fd
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
2 participants
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.
As title
Note: After https://issues.apache.org/jira/browse/INFRA-27598 done, we need to update AI related urls