Skip to content

Conversation

@qiancai
Copy link
Collaborator

@qiancai qiancai commented Jan 21, 2026

What is changed, added or deleted? (Required)

  • Replaced platform-specific blocks with unified help and support instructions in multiple developer guide documents.
  • Updated links and instructions to clearly distinguish between TiDB Cloud and TiDB Self-Managed support options, and refactored some platform-specific setup and connection steps for clarity and consistency.

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

@ti-chi-bot ti-chi-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 21, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 21, 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 assign oreoxmt for approval. 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

@qiancai qiancai self-assigned this Jan 21, 2026
@ti-chi-bot ti-chi-bot bot added area/develop This PR relates to the area of TiDB App development. missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 21, 2026
@qiancai qiancai added translation/doing This PR's assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/develop This PR relates to the area of TiDB App development. labels Jan 21, 2026
@qiancai qiancai marked this pull request as draft January 21, 2026 08:21
@qiancai qiancai added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/develop This PR relates to the area of TiDB App development. labels Jan 21, 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 significantly improves the developer documentation by standardizing how platform-specific information is presented. By eliminating conditional rendering tags and integrating unified instructions, the guides now offer a more cohesive and user-friendly experience, making it easier for developers to find relevant information for both TiDB Cloud and TiDB Self-Managed environments.

Highlights

  • Unified Help and Support Instructions: Replaced platform-specific blocks with a single, unified set of help and support instructions across numerous developer guide documents. This includes links to Discord, Slack, and distinct support ticket submission portals for TiDB Cloud and TiDB Self-Managed.
  • Refactored Platform-Specific Content: Updated and refactored various platform-specific setup, connection, and best practice instructions to be more consistent and clear, explicitly distinguishing between TiDB Cloud and TiDB Self-Managed options where necessary, without relying on conditional rendering tags.
  • Improved Documentation Clarity: Enhanced the clarity and consistency of developer guides by removing redundant or conditionally rendered content, streamlining information flow for users of both TiDB Cloud and TiDB Self-Managed.

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

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 an excellent job of unifying platform-specific content by removing <CustomContent> blocks across numerous developer guides. The changes significantly improve clarity and maintainability. The updated "Need help?" sections are now consistent and provide clearer support paths for both TiDB Cloud and Self-Managed users. I've identified a few minor issues related to grammar, typos, and consistency, along with one point of potential confusion in an import instruction. Overall, this is a very positive and impactful change.


</CustomContent>
- For TiDB Cloud, you can skip [Method 1: Via `tiup demo`](#method-1-via-tiup-demo) and import Bookshop table structures [via the import feature of TiDB Cloud](#method-2-via-tidb-cloud-import).
- For TiDB Self-Managed, you can import Bookshop table structures and data either [via TiUP](#method-1-via-tiup-demo) or [via the import feature of TiDB Cloud](#method-2-via-tidb-cloud-import).
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The instruction for TiDB Self-Managed users is a bit confusing. It suggests they can use "the import feature of TiDB Cloud", but Method 2 is specific to TiDB Cloud users and requires a TiDB Cloud account. For clarity, I suggest simplifying this instruction to only mention the TiUP method, which is the primary way for self-managed users to import this data.

Suggested change
- For TiDB Self-Managed, you can import Bookshop table structures and data either [via TiUP](#method-1-via-tiup-demo) or [via the import feature of TiDB Cloud](#method-2-via-tidb-cloud-import).
- For TiDB Self-Managed, you can import Bookshop table structures and data [via TiUP](#method-1-via-tiup-demo).
References
  1. The documentation should be clear and easy to understand for users. This instruction might confuse users of TiDB Self-Managed. (Reference: Lines 14, 21) (link)

<CustomContent platform="tidb-cloud">

- After [connecting to TiDB using the JDBC driver](/develop/dev-guide-choose-driver-or-orm.md#java-drivers), you can create a `Statement` object with `conn.createStatus()`.
After [connecting to TiDB using the JDBC driver](/develop/dev-guide-choose-driver-or-orm.md#java-drivers), you can create a `Statement` object with `conn.createStatus()`, and then call `stmt.executeQuery("query_sql")` to initiate a database query request to TiDB.
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

There seems to be a typo in the method name. conn.createStatus() should be conn.createStatement().

Suggested change
After [connecting to TiDB using the JDBC driver](/develop/dev-guide-choose-driver-or-orm.md#java-drivers), you can create a `Statement` object with `conn.createStatus()`, and then call `stmt.executeQuery("query_sql")` to initiate a database query request to TiDB.
After [connecting to TiDB using the JDBC driver](/develop/dev-guide-choose-driver-or-orm.md#java-drivers), you can create a `Statement` object with `conn.createStatement()`, and then call `stmt.executeQuery("query_sql")` to initiate a database query request to TiDB.
References
  1. The documentation must be technically accurate. The method name createStatus() is incorrect and should be createStatement(). (Reference: Line 16) (link)

> The steps provided in this guide is **_ONLY_** for quick start. For more instructions, refer to [Use an HTAP Cluster with TiFlash](/tiflash/tiflash-overview.md).
</CustomContent>
> The steps provided in this section is **_ONLY_** for quick start and testing purposes. For more information about HTAP usage in TiDB, see [explore HTAP](/explore-htap.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

low

There's a minor grammatical error here. Since "steps" is plural, the verb should be "are" instead of "is".

Suggested change
> The steps provided in this section is **_ONLY_** for quick start and testing purposes. For more information about HTAP usage in TiDB, see [explore HTAP](/explore-htap.md).
> The steps provided in this section are **_ONLY_** for quick start and testing purposes. For more information about HTAP usage in TiDB, see [explore HTAP](/explore-htap.md).
References
  1. The documentation should have correct English grammar. 'steps' is plural and requires the verb 'are'. (Reference: Line 20) (link)

Comment on lines +143 to +144
- [SQL Tuning Overview for TiDB Cloud](/tidb-cloud/tidb-cloud-sql-tuning-overview.md).
- [SQL Tuning Overview for TiDB Self-Managed](/sql-tuning-overview.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

low

For consistency across the documentation, it's better to remove the periods at the end of these list items, as they are not complete sentences.

Suggested change
- [SQL Tuning Overview for TiDB Cloud](/tidb-cloud/tidb-cloud-sql-tuning-overview.md).
- [SQL Tuning Overview for TiDB Self-Managed](/sql-tuning-overview.md).
- [SQL Tuning Overview for TiDB Cloud](/tidb-cloud/tidb-cloud-sql-tuning-overview.md)
- [SQL Tuning Overview for TiDB Self-Managed](/sql-tuning-overview.md)

</SimpleTab>

<CustomContent platform="tidb-cloud">
## Next step
Copy link
Contributor

Choose a reason for hiding this comment

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

low

For better readability and consistency with other documentation, consider changing the heading from "Next step" to "Next steps".

Suggested change
## Next step
## Next steps
References
  1. Headings should use sentence case. 'Next steps' is more conventional and aligned with this principle than 'Next step'. (Reference: Line 32) (link)

@qiancai qiancai changed the title [WIP]: Developer guides: replaced <CustomContent> content with unified instructions [WIP]: new nav: replaced <CustomContent> content with unified instructions for developer guides Jan 21, 2026
@qiancai qiancai added the type/refactor The issue belongs to a refactor work. label Jan 21, 2026
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. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XXL Denotes a PR that changes 1000+ 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