-
Notifications
You must be signed in to change notification settings - Fork 40
docs: Refactor CN tutorial structure and naming conventions #2992
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…tadata' for accuracy
…, Data Ingestion, Backup & Recovery)
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Description
This PR significantly refactors the Chinese tutorial section to improve clarity, consistency, and user experience. It standardizes titles, sidebar labels, and category names to follow a clear "Action + Tool/Object" pattern.
Key Changes
1. Category Restructuring
Renamed categories to be concise noun phrases for better navigation:
2. Title & Sidebar Standardization
Adopted a unified "Action (Tool)" or "Scenario (Tool)" format for all tutorials to clearly indicate the task and the tool used.
BendSQL 连接自建 Databend(Sidebar) /使用 BendSQL 连接自建 Databend(Title)Addax 离线迁移 MySQL(Sidebar) /使用 Addax 离线迁移 MySQL(Title)3. Content Updates
access-mysql-and-redistutorial.query-metadatatitle to查询 Stage 文件元数据for accuracy.index.mdto reflect all structural changes.Motivation
To provide a more natural, action-oriented, and consistent guide for users, making it easier to find the right tutorial for their specific needs.