docs: add Table of Contents to README (English + Chinese)#205
Open
Gingiris wants to merge 1 commit intolsdefine:mainfrom
Open
docs: add Table of Contents to README (English + Chinese)#205Gingiris wants to merge 1 commit intolsdefine:mainfrom
Gingiris wants to merge 1 commit intolsdefine:mainfrom
Conversation
The README is 500+ lines with a bilingual layout (English then Chinese). Adding a TOC for each language section makes it easier for readers to jump to the section they need without scrolling through the full document. Changes: - Added English Table of Contents after the language anchor - Added Chinese 目录 after the Chinese language anchor - Cross-linked between the two language sections 🤖 This commit was created with AI assistance and reviewed by a human.
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
1 participant
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.
What this PR does
Adds a Table of Contents to both the English and Chinese sections of the README.
Why
The README is 500+ lines with a bilingual layout. Readers currently have to scroll through the entire document to find a specific section. A clickable TOC for each language lets users jump directly to Quick Start, Bot Interface, or How It Works — the sections visited most often.
Each TOC also cross-links to the other language section, making it easy for bilingual readers to switch.
Changes
<a name="english">anchor<a name="chinese">anchor🤖 This PR was created with AI assistance and reviewed by a human.