*: create best practices TOC and index

[lilin90]

What is changed, added or deleted? (Required)

• Created TOC-best-practices.md
• Created _index.md in the best-practices directory
• Updated the format of TOC-api.md
• Added a group for TOC-tidb-cloud-releases.md

Which 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.

• master (the latest development version)
• v9.0 (TiDB 9.0 versions)
• v8.5 (TiDB 8.5 versions)
• v8.1 (TiDB 8.1 versions)
• v7.5 (TiDB 7.5 versions)
• v7.1 (TiDB 7.1 versions)
• v6.5 (TiDB 6.5 versions)
• v6.1 (TiDB 6.1 versions)
• v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

• This PR is translated from:
• Other reference link(s):

Do your changes match any of the following descriptions?

• Delete files
• Change aliases
• Need modification after applied to another branch
• Might cause conflicts after applied to another branch

[gemini-code-assist]

Summary of Changes

Hello @lilin90, I'm Gemini Code Assist¹! 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 significantly enhances the documentation structure by introducing a dedicated section for 'Best Practices,' complete with its own Table of Contents and an introductory index page. This reorganization aims to improve the discoverability and navigation of best practices guides. Additionally, it refines the presentation of API documentation and groups historical release information for better clarity, making the overall documentation more user-friendly and organized.

Highlights

• New Best Practices TOC: A dedicated Table of Contents file, TOC-best-practices.md, has been created to centralize all best practices documentation links.
• Best Practices Index Page: An _index.md file has been added to the best-practices directory, providing an introductory page for the entire best practices section.
• API TOC Formatting Update: The TOC-api.md file has been reformatted to use H2 headings for 'TiDB Cloud API' and 'TiDB Self-Managed API' sections, improving readability.
• Grouped TiDB Cloud Releases: Older release notes and maintenance notifications in TOC-tidb-cloud-releases.md are now grouped under 'Earlier Releases' and 'Earlier Notifications' for better organization.
• Main TOC Cleanup: The 'Best Practices' section has been removed from the main TOC.md file, as it is now managed by its dedicated TOC.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request effectively reorganizes the documentation by creating a dedicated table of contents and index page for 'Best Practices'. It also improves the structure of the API's table of contents. My review includes minor suggestions to align headings with the repository's style guide, which mandates sentence case for better readability.

[lilin90]

/approve

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [lilin90]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment