Skip to content

*: create TOC and add index for TiDB releases#22317

Merged
lilin90 merged 4 commits intopingcap:feature/preview-top-navigationfrom
lilin90:tidb-releases-index
Jan 13, 2026
Merged

*: create TOC and add index for TiDB releases#22317
lilin90 merged 4 commits intopingcap:feature/preview-top-navigationfrom
lilin90:tidb-releases-index

Conversation

@lilin90
Copy link
Member

@lilin90 lilin90 commented Jan 13, 2026

What is changed, added or deleted? (Required)

  • Moved the detailed release notes navigation from TOC.md to a new TOC-tidb-releases.md file.
  • Renamed releases/release-notes.md to releases/_index.md and updated all references to the new path across documentation.

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

Moved the detailed release notes navigation from TOC.md to a new TOC-tidb-releases.md file. Renamed releases/release-notes.md to releases/_index.md and updated all references to the new path across documentation. This change improves maintainability and centralizes release notes navigation.
@lilin90 lilin90 self-assigned this Jan 13, 2026
@lilin90 lilin90 added type/refactor The issue belongs to a refactor work. translation/doing This PR's assignee is translating this PR. labels Jan 13, 2026
@ti-chi-bot ti-chi-bot bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jan 13, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @lilin90, 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 documentation structure for TiDB release notes. It introduces a dedicated table of contents for releases and renames the main release notes index file to improve organization and consistency across the documentation. This change aims to streamline navigation for users looking for specific release information.

Highlights

  • Dedicated Release Notes TOC: A new file, "TOC-tidb-releases.md", has been created to house the comprehensive navigation for all TiDB release notes, separating it from the main "TOC.md".
  • Standardized Release Notes Index: The primary release notes file "releases/release-notes.md" has been renamed to "releases/_index.md" to follow a more standardized indexing convention.
  • Updated Internal References: All existing documentation files that previously linked to "releases/release-notes.md" have been updated to point to the new "releases/_index.md" path.

🧠 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 refactors the documentation for TiDB releases by moving the detailed release notes navigation to a separate file and updating links accordingly. The changes are well-executed and improve the structure of the documentation. I've provided a few suggestions to further improve clarity and maintainability, such as correcting the placement of some older release versions in the new table of contents file, improving the summary in the main release notes index, and fixing a minor typo for consistency.

Updated TOC-tidb-releases.md to use markdown headings for sections and improved the structure for better readability. No content changes to the release list; only formatting and organization were modified.
Reorganized the table of contents in TOC-tidb-cloud-releases.md for better readability by adding section headers and updating list formatting.
@ti-chi-bot ti-chi-bot bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 13, 2026
Added '/tidb/v8.5/release-notes/' to the list of aliases for the release notes page to improve accessibility for users seeking v8.5 documentation.
@lilin90 lilin90 added the lgtm label Jan 13, 2026
@lilin90
Copy link
Member Author

lilin90 commented Jan 13, 2026

/approve

@ti-chi-bot
Copy link

ti-chi-bot bot commented Jan 13, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 the approved label Jan 13, 2026
@lilin90 lilin90 merged commit 3da0d78 into pingcap:feature/preview-top-navigation Jan 13, 2026
6 of 9 checks passed
@lilin90 lilin90 deleted the tidb-releases-index branch January 13, 2026 09:24
@lilin90 lilin90 added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Jan 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm size/XXL Denotes a PR that changes 1000+ 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