new nav: reorganize entries in TOC-develop.md#22396
new nav: reorganize entries in TOC-develop.md#22396qiancai merged 5 commits intopingcap:feature/preview-top-navigationfrom
Conversation
Summary of ChangesHello @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 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. Changelog
Activity
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
|
There was a problem hiding this comment.
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
| ## 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 |
There was a problem hiding this comment.
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.
| ## 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
- Use sentence case for headings (e.g.,
## Configure the cluster). (link)
|
[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 |
There was a problem hiding this comment.
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.
|
/gemini review |
There was a problem hiding this comment.
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.
4426d35
into
pingcap:feature/preview-top-navigation
What is changed, added or deleted? (Required)
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?