*: create TOC and add index for TiDB releases#22317
*: create TOC and add index for TiDB releases#22317lilin90 merged 4 commits intopingcap:feature/preview-top-navigationfrom
Conversation
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.
Summary of ChangesHello @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
🧠 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 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 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.
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.
|
/approve |
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
3da0d78
into
pingcap:feature/preview-top-navigation
What is changed, added or deleted? (Required)
TOC.mdto a newTOC-tidb-releases.mdfile.releases/release-notes.mdtoreleases/_index.mdand 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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?