Skip to content

new nav release-7.5: remove develop guide, releases, and best practices from TOC.md#22403

Open
qiancai wants to merge 1 commit intopingcap:release-7.5from
qiancai:v7.5/update-links-for-new-nav
Open

new nav release-7.5: remove develop guide, releases, and best practices from TOC.md#22403
qiancai wants to merge 1 commit intopingcap:release-7.5from
qiancai:v7.5/update-links-for-new-nav

Conversation

@qiancai
Copy link
Collaborator

@qiancai qiancai commented Feb 5, 2026

What is changed, added or deleted? (Required)

  • Removed doc entries for Develop/Best Practices/Release Notes
  • Moved TiDB Installation Packages from the Release Notes category to the References category
  • Moved files into best-practices/ and develop/ (ddl-introduction.md -> best-practices/, best-practices-on-public-cloud.md -> best-practices/, java-app-best-practices.md -> develop/).
  • Updated internal links in multiple docs (faq, performance-tuning-practices, SQL DDL docs, DXF doc, upgrade guide, telemetry) to point to the new paths.

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
Copy link

ti-chi-bot bot commented Feb 5, 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 yikeke 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

@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/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 5, 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 reorganizes the documentation structure by removing several high-level categories from the main Table of Contents and relocating their associated content into more specific subdirectories. This effort aims to enhance the logical grouping and discoverability of documentation, making it more intuitive for users to navigate and find relevant information.

Highlights

  • Documentation Structure Refinement: Removed the top-level 'Develop', 'Best Practices', and 'Release Notes' sections from the main Table of Contents (TOC.md) to streamline navigation and improve content organization.
  • Content Relocation and Renaming: Several key documentation files, including 'ddl-introduction.md', 'best-practices-on-public-cloud.md', and 'java-app-best-practices.md', have been moved and renamed into more appropriate 'best-practices/' or 'develop/' subdirectories.
  • Internal Link Updates: All affected internal links across various documentation files have been meticulously updated to reflect the new paths of the relocated content, ensuring documentation integrity and preventing broken links.
  • Categorization Adjustment: The 'TiDB Installation Packages' entry has been moved from the removed 'Release Notes' section to the 'References' section within TOC.md for better logical grouping.

🧠 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-tidb-cloud.md
    • Updated the path for 'DDL Execution Principles and Best Practices' to its new location within 'best-practices/'.
  • TOC.md
    • Removed the entire 'Develop' section, which included numerous sub-sections on quick starts, example applications, database connection, schema design, data operations, transactions, optimization, and troubleshooting.
    • Removed 'TiDB Best Practices on Public Cloud' from the 'Performance Tuning' section.
    • Removed the entire 'Best Practices' section, which contained various best practice guides.
    • Moved 'TiDB Installation Packages' from the removed 'Release Notes' section to the 'References' section.
    • Removed the entire 'Release Notes' section, which listed all historical release versions.
  • best-practices-on-public-cloud.md
    • Renamed to 'best-practices/best-practices-on-public-cloud.md'.
  • best-practices/java-app-best-practices.md
    • Renamed to 'develop/java-app-best-practices.md'.
  • ddl-introduction.md
    • Renamed to 'best-practices/ddl-introduction.md'.
  • develop/dev-guide-connection-parameters.md
    • Updated the internal link for 'Best Practices for Developing Java Applications with TiDB' to its new 'develop/' path.
  • develop/dev-guide-optimize-sql-best-practices.md
    • Updated the internal link for 'Best Practices for Developing Java Applications with TiDB' to its new 'develop/' path.
  • faq/sql-faq.md
    • Updated the internal link for 'Execution Principles and Best Practices of DDL Statements' to its new 'best-practices/' path.
  • performance-tuning-practices.md
    • Updated the internal link for 'Best Practices for Developing Java Applications with TiDB' to its new 'develop/' path.
  • releases/release-7.0.0.md
    • Updated multiple internal links related to DDL documentation to their new 'best-practices/' path.
  • releases/release-7.1.0.md
    • Updated the internal link for 'Fast Online DDL' documentation to its new 'best-practices/' path.
  • releases/release-7.2.0.md
    • Updated the internal link for 'DDL related commands' documentation to its new 'best-practices/' path.
  • releases/release-7.5.0.md
    • Updated the internal link for 'DDL related commands' documentation to its new 'best-practices/' path.
  • sql-statements/sql-statement-admin-show-ddl.md
    • Updated the internal link for 'How the Online DDL Asynchronous Change Works in TiDB' to its new 'best-practices/' path.
  • telemetry.md
  • tidb-distributed-execution-framework.md
    • Updated the internal link for 'Execution Principles and Best Practices of DDL Statements' to its new 'best-practices/' path.
  • upgrade-tidb-using-tiup.md
Activity
  • The author, qiancai, has provided a clear and detailed description of the changes, outlining the removal of documentation entries, relocation of files, and updates to internal links.
  • The pull request targets the master branch, indicating these changes are intended for the latest development version of the documentation.
  • No specific review comments or approvals are available in the provided context.
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 refactors the documentation by removing the 'Develop', 'Best Practices', and 'Release Notes' sections from the main table of contents and moving several files to new locations. The changes include updating all internal links to reflect these moves. The modifications are well-executed and align with the stated goals. I've provided a few minor suggestions to improve sentence structure and readability in some of the updated files, in line with the documentation style guide.

@qiancai qiancai added the type/refactor The issue belongs to a refactor work. label Feb 5, 2026
@qiancai qiancai self-assigned this Feb 5, 2026
@qiancai qiancai added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. and removed missing-translation-status This PR does not have translation status info. labels Feb 5, 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/hold Indicates that a PR should not merge because someone has issued a /hold command. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a 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