release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs#22420
Merged
qiancai merged 49 commits intorelease-8.5from Feb 11, 2026
Merged
release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs#22420qiancai merged 49 commits intorelease-8.5from
qiancai merged 49 commits intorelease-8.5from
Conversation
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
* *: create TOC and add index for TiDB releases 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. * Reformat and reorganize TiDB releases TOC 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. * Improve formatting of TiDB Cloud releases TOC Reorganized the table of contents in TOC-tidb-cloud-releases.md for better readability by adding section headers and updating list formatting. * Add alias for TiDB v8.5 release notes 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.
Standardized section headers and link labels for TiDB Cloud and Self-Managed APIs in the table of contents. Improved clarity by renaming links to include 'API' and removed the beta image from the TiDB Cloud section.
…t-practices.md to /develop (#22360)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…or developer guides (#22353)
* new nav: categorize best practices TOC items Organized the table of contents into sections: Overview, Schema Design, Deployment, Operations, Performance Tuning, and Application Scenarios. This improves readability and helps users find relevant best practices more easily. * Refactor TOC to use nested list format Reorganized the Table of Contents in TOC-best-practices.md to use a nested list format for improved readability and structure. This change groups related best practices under their respective categories using indentation. * Update format * Remove an extra line * Update TOC-best-practices.md
* *: enrich best practices index and move one doc * Expand TiDB best practices overview and schema design Added detailed sections and tables for best practice topics, including an overview and schema design recommendations. Introduced links to specific best practice documents for DDL management, UUID primary keys, multi-column indexes, and index management. Added placeholders for deployment, operations, and performance tuning sections. * Update best practices index and PD scheduling terms Expanded the best practices index with detailed tables and descriptions for deployment, operations, and performance tuning topics. Updated 'scale-down' terminology to 'scale-in' in the PD scheduling best practices document for consistency and clarity. * Add aliases to public cloud best practices doc Added aliases to the TiDB best practices on public cloud documentation for improved URL compatibility and easier access. * Update descriptions * Update wording * Apply suggestions from code review Co-authored-by: Grace Cai <qqzczy@126.com> * Update _index.md --------- Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: qiancai <qqzczy@126.com>
Co-authored-by: lilin90 <lilin@pingcap.com>
…or best practices (#22383)
13 tasks
* chore(package): update package.json and package-lock.json to add new devDependencies for linting and markdown checks * chore(scripts): add script to verify internal links in TOC files and ensure all referenced pages exist * chore(ci): restructure CI workflow to add jobs for verifying duplicated file names, internal links, and TOC membership * chore(scripts): enhance internal link verification script with configurable verbosity and limits for missing pages and violations * chore(scripts): extend internal link verification to include source TOC references in violation reports * chore(scripts): improve output formatting in internal link verification script for better readability * chore(scripts): refactor internal link verification script to improve target extraction and sorting logic * chore(scripts): format code for improved readability in internal link verification script
qiancai
added
translation/done
[LGTM Timeline notifier]Timeline:
|
qiancai
added
needs-cherry-pick-master
Collaborator
Author
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai 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 |
ti-chi-bot
pushed a commit
to ti-chi-bot/docs
that referenced
this pull request
Feb 11, 2026
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
Member
|
In response to a cherrypick label: new pull request created to branch |
Merged
13 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is changed, added or deleted? (Required)
This PR reorganizes the documentation structure and improves experiences of developers by making the following changes:
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?