new nav: categorize best practices TOC items #22375
Conversation
Organized the table of contents into sections: Overview, Schema Design, Deployment, Operations, Performance Tuning, and Application Scenarios. This improves readability and helps users find relevant best practices more easily.
lilin90
added
type/refactor
Summary of ChangesHello @lilin90, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the user experience for the TiDB documentation by introducing a structured categorization to the best practices Table of Contents. The change aims to improve the discoverability and logical grouping of various best practice guides, allowing users to more efficiently navigate and locate relevant information based on specific areas like schema design, deployment, or performance tuning. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
the
size/M
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request does a great job of reorganizing the best practices table of contents, making it much more structured and easier to navigate. The new categories are logical and help users find relevant documents quickly. I have a few minor suggestions to align the headings with the repository's style guide, which recommends using sentence case for headings.
| <!-- markdownlint-disable MD007 --> | ||
| <!-- markdownlint-disable MD041 --> | ||
|
|
||
| # Table of Contents |
There was a problem hiding this comment.
According to the repository's style guide, headings should use sentence case. Please change 'Table of Contents' to 'Table of contents'.
| # Table of Contents | |
| # Table of contents |
References
- The style guide specifies that headings should be in sentence case (e.g.,
## Configure the cluster). (link)
|
|
||
| - [Use TiDB](/best-practices/tidb-best-practices.md) | ||
|
|
||
| ## Schema Design |
There was a problem hiding this comment.
To adhere to the repository's style guide, which specifies sentence case for headings, please change 'Schema Design' to 'Schema design'.
| ## Schema Design | |
| ## Schema design |
References
- The style guide specifies that headings should be in sentence case (e.g.,
## Configure the cluster). (link)
| - [Use HAProxy for Load Balancing](/best-practices/haproxy-best-practices.md) | ||
| - [Monitor TiDB Using Grafana](/best-practices/grafana-monitor-best-practices.md) | ||
|
|
||
| ## Performance Tuning |
There was a problem hiding this comment.
The repository's style guide recommends using sentence case for headings. Please update 'Performance Tuning' to 'Performance tuning'.
| ## Performance Tuning | |
| ## Performance tuning |
References
- The style guide specifies that headings should be in sentence case (e.g.,
## Configure the cluster). (link)
| - [Three-Node Hybrid Deployment](/best-practices/three-nodes-hybrid-deployment.md) | ||
| - [Local Reads in Three-Data-Center Deployments](/best-practices/three-dc-local-read.md) | ||
|
|
||
| ## Application Scenarios |
There was a problem hiding this comment.
To follow the repository's style guide for headings, please use sentence case. 'Application Scenarios' should be changed to 'Application scenarios'.
| ## Application Scenarios | |
| ## Application scenarios |
References
- The style guide specifies that headings should be in sentence case (e.g.,
## Configure the cluster). (link)
1 participant
What is changed, added or deleted? (Required)
Updated
TOC-best-practices.mdto categorize best practicesWhich TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?