docs: add numbered headings and improve README structure#117
Merged
Conversation
Contributor
duguwanglong
commented
Apr 14, 2026
duguwanglong
commented
- Add numbered section headings (1-6) for clearer navigation
- Merge quick install and source install into a single "choose one" step to avoid misleading readers into running both sequentially
- Replace plain-text deployment options with a table for visual emphasis
- Fix heading levels: promote "Installation & Usage" from H1 to H2, demote Docker "Start service" from H2 to H4
- Fix PowerShell code block language tags (bash → powershell)
- Fix typo: "useage" → "usage" in English README
- Add numbered section headings (1-6) for clearer navigation - Merge quick install and source install into a single "choose one" step to avoid misleading readers into running both sequentially - Replace plain-text deployment options with a table for visual emphasis - Fix heading levels: promote "Installation & Usage" from H1 to H2, demote Docker "Start service" from H2 to H4 - Fix PowerShell code block language tags (bash → powershell) - Fix typo: "useage" → "usage" in English README Made-with: Cursor
Use install_zh.sh/install_zh.ps1 in Option B to be consistent with Option A and the purpose of the Chinese README. Made-with: Cursor
xiami762
approved these changes
Apr 14, 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
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.