refactor(ai): sync the ai doc/structure - #409
Merged
Merged
Conversation
dosubot
Bot
added
size:L
Contributor
There was a problem hiding this comment.
Pull Request Overview
Aligns and standardizes markdown indentation in the Chinese quickstart for HugeGraph-AI to resolve rendering issues.
- Fix list item markers and nesting under ordered steps.
- Normalize indentation for code fences across Docker and source-build instructions.
- Ensure consistent formatting in examples and tip blocks.
Comments suppressed due to low confidence (2)
content/cn/docs/quickstart/hugegraph-ai/_index.md:66
- This line is a nested point under step 1 but lacks a list marker. Consider adding
-before the text or adjusting indentation so it renders as part of the list.
有一个使用 docker 的简单方法：
content/cn/docs/quickstart/hugegraph-ai/_index.md:107
- These link lines under step 7 are not marked as list items, which may break the nested list. Add
-before each or indent appropriately to maintain the list structure.
[hugegraph-hubble](/docs/quickstart/toolchain/hugegraph-hubble/#21-use-docker-convenient-for-testdev)
imbajin
reviewed
Jul 2, 2025
Member
There was a problem hiding this comment.
THX, We already updated the doc yesterday & I will sync it now
Rewrote and streamlined the HugeGraph-AI quickstart documentation for clarity, highlighting key features, modules, and usage examples. Added a new 'hugegraph-llm.md' with detailed environment setup, Docker/source installation, and code examples for knowledge graph construction and RAG. Enabled Mermaid.js in config.toml with a note to upgrade Docsy for full support.
dosubot
Bot
added
size:XL
Majorly rewrote and reorganized the hugegraph-llm.md documentation for clarity, modern deployment options, and improved usage examples. Added Docker Compose instructions, clarified prerequisites, and enhanced code and workflow examples. Adjusted document weights to prioritize the main HugeGraph-LLM guide over the UI details.
imbajin
changed the title
Updated the HugeGraph-AI quickstart index with a more concise, modular overview, deployment instructions, and usage examples. Added a new detailed Chinese guide for HugeGraph-LLM, covering features, setup, and code samples. Adjusted the quick_start.md weight for navigation consistency.
dosubot
Bot
added
size:XXL
Member
|
TODO: (Merge current PR first) refer #408 |
imbajin
approved these changes
Jul 2, 2025
github-actions Bot
pushed a commit
that referenced
this pull request
Jul 2, 2025
* Refactor HugeGraph-AI quickstart docs and add LLM guide --------- Co-authored-by: imbajin <jin@apache.org> 3e1c610
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.
In the
content/cn/docs/quickstart/hugegraph-ai/_index.md, the first-line front matter is not properly indented, resulting in rendering issues and layout problems on the documentation page. This PR includes a fix by checking and correcting the indentation of the document.before:
now:
