[WIP]: Create TOC and overview docs for API

[qiancai]

First-time contributors' checklist

• I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added or deleted? (Required)

• Introduces new API overview documentation for TiDB Cloud and TiDB Self-Managed
• Create the API table of contents
• Removes the old TiDB Cloud API overview from tidb-cloud/api-overview.md, consolidating and clarifying API documentation structure.

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 @qiancai, 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 reorganizes and expands the API documentation for TiDB, aiming to provide a more structured and user-friendly experience. It introduces a new top-level API overview page and a dedicated table of contents, clearly distinguishing between TiDB Cloud and TiDB Self-Managed APIs. This refactoring involves creating several new overview documents for specific API components and consolidating existing information, ultimately enhancing the discoverability and clarity of TiDB's API offerings.

Highlights

• API Documentation Restructuring: Introduced a new, centralized structure for API documentation, clearly separating TiDB Cloud and TiDB Self-Managed APIs for improved organization.
• New API Overview Pages: Created dedicated overview pages for various TiDB Self-Managed APIs (TiProxy, Data Migration, Monitoring, TiCDC, TiDB Operator) and a comprehensive TiDB Cloud API overview, enhancing clarity and detail.
• Centralized Table of Contents: Implemented a new 'TOC-api.md' file to provide a clear, hierarchical table of contents for all API documentation, making navigation more intuitive.
• Consolidation and Removal of Redundant Content: Removed the old 'tidb-cloud/api-overview.md' file, consolidating its content into the new structure to eliminate redundancy and improve maintainability.

🧠 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 introduces new API overview documentation and a table of contents, which significantly improves the structure and clarity of the API documentation. The changes are well-organized and provide a solid foundation for API users. I've included several suggestions to enhance grammar, maintain consistency, and ensure technical accuracy across the new documents, aligning with the repository's style guide.

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

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

Details

Needs approval from an approver in each of these files:

• OWNERS

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