new nav release-8.1: remove develop guide, releases, and best practices from TOC.md#22400
new nav release-8.1: remove develop guide, releases, and best practices from TOC.md#22400qiancai wants to merge 3 commits intopingcap:release-8.1from
Conversation
Move and reorganize documentation pages into proper folders and update references. Renamed/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/). Cleaned up TOC (removed inlined Develop/Best Practices lists and duplicate Release Notes entries, added TiDB Installation Packages entry). Updated internal links in multiple docs (faq, performance-tuning-practices, SQL DDL docs, DXF doc, upgrade guide, telemetry) to point to the new paths and use the canonical release notes URL.
ti-chi-bot
bot
added
area/develop
Summary of ChangesHello @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 and navigation for the upcoming TiDB 8.1 release. It involves a significant cleanup of the Table of Contents by removing outdated or less relevant top-level sections and reorganizing existing content into more logical categories. This restructuring is complemented by comprehensive updates to internal links throughout the documentation, ensuring that users can seamlessly navigate to the correct information despite the underlying file system changes. 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. Changelog
Activity
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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request primarily refactors the documentation by removing the 'Develop', 'Best Practices', and 'Release Notes' sections from the table of contents and moving several files to new locations. The corresponding internal links have been updated across multiple documents. The changes are consistent with the PR description and help simplify the documentation structure. I've added a couple of minor suggestions to ensure consistent capitalization for 'Release Notes' link text, in line with the repository's style guide.
qiancai
added
translation/done
[LGTM Timeline notifier]Timeline:
|
This reverts commit 0e0f8cb.
ti-chi-bot
bot
added
size/XS
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
size/XL
qiancai
added
the
do-not-merge/hold
2 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
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?