Skip to content

new nav release-5.4: remove releases and and best practices from TOC.md#22407

Open
qiancai wants to merge 1 commit intopingcap:release-5.4from
qiancai:v5.4/update-links-for-new-nav
Open

new nav release-5.4: remove releases and and best practices from TOC.md#22407
qiancai wants to merge 1 commit intopingcap:release-5.4from
qiancai:v5.4/update-links-for-new-nav

Conversation

@qiancai
Copy link
Collaborator

@qiancai qiancai commented Feb 5, 2026

First-time contributors' checklist

What is changed, added or deleted? (Required)

  • Removed doc entries for Best Practices/Release Notes
  • Moved TiDB Installation Packages from the Release Notes category to the References category
  • Moved java-app-best-practices.md -> develop/

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 jackysp 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 missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 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 refines the documentation structure for TiDB 5.4 by removing outdated or less relevant sections from the primary navigation. It also includes a reclassification of certain documentation files and updates internal links to ensure all references point to the correct and most current information, thereby enhancing the overall clarity and maintainability of the documentation.

Highlights

  • Table of Contents Streamlining: The main Table of Contents (TOC.md) has been updated to remove the 'Best Practices' and 'Release Notes' sections, simplifying the documentation navigation structure.
  • Documentation File Reorganization: The file 'java-app-best-practices.md' has been moved from the 'best-practices/' directory to the 'develop/' directory, indicating a reclassification of its content.
  • Internal Link Updates: Several internal links across various documentation files, including 'br/backup-and-restore-use-cases.md', 'telemetry.md', and 'upgrade-tidb-using-tiup.md', have been updated to point to a new, centralized external URL for release notes.

🧠 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.md
    • Removed the 'Best Practices' section and all its associated sub-entries.
    • Removed the extensive 'Release Notes' section, which included entries for numerous historical versions.
  • best-practices/java-app-best-practices.md -> develop/java-app-best-practices.md
    • The file 'java-app-best-practices.md' was moved from the 'best-practices/' directory to the 'develop/' directory.
  • br/backup-and-restore-use-cases.md
  • telemetry.md
  • upgrade-tidb-using-tiup.md
Activity
  • No human activity 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.

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 updates the navigation for the release-5.4 documentation by removing the 'Best Practices', 'Develop Guide', and 'Release Notes' sections from the table of contents. It also updates several internal links that were pointing to the now-removed release notes. The changes are straightforward and achieve the stated goal. I've added one minor suggestion to improve readability in one of the updated files.

@qiancai qiancai changed the title new nav release-5.4: remove develop guide, releases, and best practices from TOC.md new nav release-5.4: remove releases and and best practices from TOC.md Feb 5, 2026
@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

do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. size/L Denotes a PR that changes 100-499 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