Skip to content

new nav: reorganize entries in TOC-develop.md#22396

Merged
qiancai merged 5 commits intopingcap:feature/preview-top-navigationfrom
qiancai:categorize-dev-guide-toc
Feb 4, 2026
Merged

new nav: reorganize entries in TOC-develop.md#22396
qiancai merged 5 commits intopingcap:feature/preview-top-navigationfrom
qiancai:categorize-dev-guide-toc

Conversation

@qiancai
Copy link
Collaborator

@qiancai qiancai commented Feb 3, 2026

What is changed, added or deleted? (Required)

  • Reorganized existing entries into categories: QUICK START, GUIDES, EXAMPLES, INTEGRATIONS, and REFERENCE.
  • Updated a few docs according to the new TOC.

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

@qiancai qiancai self-assigned this Feb 3, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @qiancai, 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 refactors the TOC-develop.md file to provide a more structured and intuitive table of contents for developer documentation. The changes aim to improve the organization and navigation of content, making it easier for users to locate specific guides, examples, and reference materials within the TiDB development ecosystem.

Highlights

  • Table of Contents Restructuring: The TOC-develop.md file has been significantly reorganized to introduce a clearer, categorized structure for developer documentation. New top-level headings such as 'Table of Contents', 'QUICK START', 'GUIDES', 'EXAMPLES', 'INTEGRATIONS', and 'REFERENCE' have been added.
  • Content Categorization: Existing documentation entries have been logically grouped and moved under these new categories, enhancing discoverability and improving the overall navigation experience for users.
  • Entry Renaming: The 'Transactions' entry has been renamed to 'Manage Transactions' for improved clarity and consistency within the documentation.

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

Changelog
  • TOC-develop.md
    • Introduced a main title # Table of Contents at the beginning of the file.
    • Added new section headings: ## QUICK START, ## GUIDES, ## EXAMPLES, ## INTEGRATIONS, and ## REFERENCE.
    • Reorganized existing documentation links and sections, placing them under their respective new thematic categories.
    • Renamed the 'Transactions' entry to 'Manage Transactions' for better descriptive accuracy.
Activity
  • No specific activity (comments, reviews, or progress updates) has been recorded for this pull request yet.
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.

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 3, 2026
@qiancai qiancai added the type/refactor The issue belongs to a refactor work. label Feb 3, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request reorganizes the developer documentation's table of contents into logical categories, which improves its structure. My review focuses on ensuring the changes adhere to the repository's documentation style guide. I've suggested a few minor adjustments to align heading capitalization and link text with the guide's conventions for consistency.

TOC-develop.md Outdated
Comment on lines 104 to 115
## EXAMPLES

- [Bookshop Example Application](/develop/dev-guide-bookshop-schema-design.md)

## INTEGRATIONS

- [Third-Party Tools Supported by TiDB](/develop/dev-guide-third-party-support.md)
- [Known Incompatibility Issues with Third-Party Tools](/develop/dev-guide-third-party-tools-compatibility.md)
- [ProxySQL Integration Guide](/develop/dev-guide-proxysql-integration.md)
- [Amazon AppFlow Integration Guide](/develop/dev-guide-aws-appflow-integration.md)

## REFERENCE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

According to the repository's style guide (line 32), headings should use sentence case (e.g., ## Configure the cluster). Please update these headings to follow that convention.

Suggested change
## EXAMPLES
- [Bookshop Example Application](/develop/dev-guide-bookshop-schema-design.md)
## INTEGRATIONS
- [Third-Party Tools Supported by TiDB](/develop/dev-guide-third-party-support.md)
- [Known Incompatibility Issues with Third-Party Tools](/develop/dev-guide-third-party-tools-compatibility.md)
- [ProxySQL Integration Guide](/develop/dev-guide-proxysql-integration.md)
- [Amazon AppFlow Integration Guide](/develop/dev-guide-aws-appflow-integration.md)
## REFERENCE
## Examples
- [Bookshop Example Application](/develop/dev-guide-bookshop-schema-design.md)
## Integrations
- [Third-Party Tools Supported by TiDB](/develop/dev-guide-third-party-support.md)
- [Known Incompatibility Issues with Third-Party Tools](/develop/dev-guide-third-party-tools-compatibility.md)
- [ProxySQL Integration Guide](/develop/dev-guide-proxysql-integration.md)
- [Amazon AppFlow Integration Guide](/develop/dev-guide-aws-appflow-integration.md)
## Reference
References
  1. Use sentence case for headings (e.g., ## Configure the cluster). (link)

@ti-chi-bot ti-chi-bot bot added the area/develop This PR relates to the area of TiDB App development. label Feb 3, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 3, 2026

[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:

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

@ti-chi-bot ti-chi-bot bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 3, 2026
Copy link
Collaborator Author

@qiancai qiancai Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This document is renamed from "develop/dev-guide-connect-to-tidb.md", and it only keeps the instructions for MySQL tool connection in "develop/dev-guide-connect-to-tidb.md" because the other connection methods have already been described in other docs.

@qiancai qiancai added the translation/doing This PR's assignee is translating this PR. label Feb 3, 2026
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Feb 3, 2026
@qiancai
Copy link
Collaborator Author

qiancai commented Feb 4, 2026

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request does a great job of reorganizing the developer documentation's table of contents, making it much more structured and easier to navigate. The new categories like QUICK START, GUIDES, INTEGRATIONS, and REFERENCE are logical. The updates to related documents to reflect these changes, such as renaming titles from "Build" to "Create" and refactoring the connection guide, are consistent and improve clarity.

My main feedback is a minor style issue in TOC-develop.md where the new main headings are in uppercase. According to the repository's style guide, headings should be in sentence case. I've added suggestions to correct this.

@qiancai qiancai merged commit 4426d35 into pingcap:feature/preview-top-navigation Feb 4, 2026
5 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/develop This PR relates to the area of TiDB App development. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR. type/refactor The issue belongs to a refactor work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant