master: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)#22439
Merged
qiancai merged 5 commits intopingcap:masterfrom Feb 11, 2026
Merged
Conversation
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
ti-chi-bot
added
area/develop
13 tasks
Member
Author
|
@qiancai This PR has conflicts, I have hold it. |
|
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository. |
Contributor
Summary of ChangesHello @ti-chi-bot, 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 significantly refactors the documentation's information architecture for TiDB and TiDB Cloud. The changes aim to enhance user experience by introducing new, intuitive top-level navigation categories and centralizing related content. This reorganization provides a clearer, more streamlined path for users to discover and access relevant information, particularly for AI, API, and developer-focused topics. 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
Ignored Files
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}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a major reorganization of the documentation, which is a great improvement for the information architecture. However, it seems the cherry-pick process has left unresolved merge conflicts in numerous files. These conflict markers (e.g., <<<<<<<, =======, >>>>>>>) need to be resolved before merging. I've added comments on a few examples, but please check all files for similar issues.
TOC-tidb-cloud.md
Outdated
Comment on lines
11
to
18
| <<<<<<< HEAD | ||
| - Get Started with TiDB Cloud | ||
| - [Try Out TiDB Cloud Serverless](/tidb-cloud/tidb-cloud-quickstart.md) | ||
| - [Try Out TiDB + AI](/vector-search/vector-search-get-started-using-python.md) | ||
| ======= | ||
| - Get Started | ||
| - [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md) | ||
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)) |
Contributor
There was a problem hiding this comment.
This file contains unresolved merge conflicts. Please resolve them before merging. The 'Get Started' section needs to be cleaned up. I'd suggest using the version from the b7469123c6 commit as it seems more consistent with the new information architecture.
Suggested change
| <<<<<<< HEAD | |
| - Get Started with TiDB Cloud | |
| - [Try Out TiDB Cloud Serverless](/tidb-cloud/tidb-cloud-quickstart.md) | |
| - [Try Out TiDB + AI](/vector-search/vector-search-get-started-using-python.md) | |
| ======= | |
| - Get Started | |
| - [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md) | |
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)) | |
| - Get Started | |
| - [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md) |
Comment on lines
29
to
33
| <<<<<<< HEAD:tidb-cloud/vector-search-full-text-search-python.md | ||
| Full-text search is still in the early stages, and we are continuously rolling it out to more customers. Currently, Full-text search is only available for the following product option and regions: | ||
| ======= | ||
| Full-text search is still in the early stages, and we are continuously rolling it out to more customers. Currently, full-text search is only available on {{{ .starter }}} and {{{ .essential }}} in the following regions: | ||
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)):ai/guides/vector-search-full-text-search-python.md |
Contributor
There was a problem hiding this comment.
This file contains unresolved merge conflicts. Please resolve them before merging. The prerequisite description for full-text search needs to be unified. The version using template variables ({{{ .starter }}} and {{{ .essential }}}) seems more appropriate for maintainability.
Suggested change
| <<<<<<< HEAD:tidb-cloud/vector-search-full-text-search-python.md | |
| Full-text search is still in the early stages, and we are continuously rolling it out to more customers. Currently, Full-text search is only available for the following product option and regions: | |
| ======= | |
| Full-text search is still in the early stages, and we are continuously rolling it out to more customers. Currently, full-text search is only available on {{{ .starter }}} and {{{ .essential }}} in the following regions: | |
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)):ai/guides/vector-search-full-text-search-python.md | |
| Full-text search is still in the early stages, and we are continuously rolling it out to more customers. Currently, full-text search is only available on {{{ .starter }}} and {{{ .essential }}} in the following regions: |
system-variable-reference.md
Outdated
Comment on lines
3547
to
3552
| <<<<<<< HEAD | ||
| - [TiDB Best Practices on Public Cloud](/best-practices-on-public-cloud.md) | ||
| ======= | ||
| - [TiDB Best Practices on Public Cloud](/best-practices/best-practices-on-public-cloud.md) | ||
| - [TiDB 8.5.4 Release Notes](/releases/release-8.5.4.md) | ||
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)) |
Contributor
There was a problem hiding this comment.
This file contains unresolved merge conflicts. Please resolve them before merging. The path for best-practices-on-public-cloud.md and the additional release note link need to be correctly merged. The version from the b7469123c6 commit seems to have the correct path and additional information.
Suggested change
| <<<<<<< HEAD | |
| - [TiDB Best Practices on Public Cloud](/best-practices-on-public-cloud.md) | |
| ======= | |
| - [TiDB Best Practices on Public Cloud](/best-practices/best-practices-on-public-cloud.md) | |
| - [TiDB 8.5.4 Release Notes](/releases/release-8.5.4.md) | |
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)) | |
| - [TiDB Best Practices on Public Cloud](/best-practices/best-practices-on-public-cloud.md) | |
| - [TiDB 8.5.4 Release Notes](/releases/release-8.5.4.md) |
variables.json
Outdated
Comment on lines
3
to
9
| <<<<<<< HEAD | ||
| "tidb-version": "v8.5.0", | ||
| ======= | ||
| "tidb-version": "8.5.5", | ||
| "tidb-release-date": "2026-01-15", | ||
| "tidb-operator-version": "v1.6.4", | ||
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)) |
Contributor
There was a problem hiding this comment.
This file contains unresolved merge conflicts. Please resolve the tidb-version and other variables. The version from the b7469123c6 commit appears to be more up-to-date.
"tidb-version": "8.5.5",
"tidb-release-date": "2026-01-15",
"tidb-operator-version": "v1.6.4",
upgrade-tidb-using-tiup.md
Outdated
Comment on lines
64
to
77
| <<<<<<< HEAD | ||
| Review [the compatibility changes](/releases/release-8.5.0.md#compatibility-changes) in TiDB v8.5.0 release notes. If any changes affect your upgrade, take actions accordingly. | ||
| ======= | ||
| Review compatibility changes in TiDB release notes. If any changes affect your upgrade, take actions accordingly. | ||
|
|
||
| The following provides release notes you need to know when you upgrade from v8.4.0 to the current version (v{{{ .tidb-version }}}). If you are upgrading from v8.3.0 or earlier versions to the current version, you might also need to check the [release notes](/releases/_index.md) of the intermediate versions. | ||
|
|
||
| - TiDB v8.5.0 [compatibility changes](/releases/release-8.5.0.md#compatibility-changes) | ||
| - TiDB v8.5.1 [release notes](/releases/release-8.5.1.md) | ||
| - TiDB v8.5.2 [release notes](/releases/release-8.5.2.md) | ||
| - TiDB v8.5.3 [compatibility changes](/releases/release-8.5.3.md#compatibility-changes) | ||
| - TiDB v8.5.4 [compatibility changes](/releases/release-8.5.4.md#compatibility-changes) | ||
| - TiDB v8.5.5 [compatibility changes](https://docs.pingcap.com/tidb/stable/release-8.5.5/#compatibility-changes) | ||
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)) |
Contributor
There was a problem hiding this comment.
This file contains unresolved merge conflicts. Please resolve them before merging. The section on reviewing compatibility changes needs to be cleaned up. The more detailed version from the b7469123c6 commit seems preferable.
Suggested change
| <<<<<<< HEAD | |
| Review [the compatibility changes](/releases/release-8.5.0.md#compatibility-changes) in TiDB v8.5.0 release notes. If any changes affect your upgrade, take actions accordingly. | |
| ======= | |
| Review compatibility changes in TiDB release notes. If any changes affect your upgrade, take actions accordingly. | |
| The following provides release notes you need to know when you upgrade from v8.4.0 to the current version (v{{{ .tidb-version }}}). If you are upgrading from v8.3.0 or earlier versions to the current version, you might also need to check the [release notes](/releases/_index.md) of the intermediate versions. | |
| - TiDB v8.5.0 [compatibility changes](/releases/release-8.5.0.md#compatibility-changes) | |
| - TiDB v8.5.1 [release notes](/releases/release-8.5.1.md) | |
| - TiDB v8.5.2 [release notes](/releases/release-8.5.2.md) | |
| - TiDB v8.5.3 [compatibility changes](/releases/release-8.5.3.md#compatibility-changes) | |
| - TiDB v8.5.4 [compatibility changes](/releases/release-8.5.4.md#compatibility-changes) | |
| - TiDB v8.5.5 [compatibility changes](https://docs.pingcap.com/tidb/stable/release-8.5.5/#compatibility-changes) | |
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)) | |
| Review compatibility changes in TiDB release notes. If any changes affect your upgrade, take actions accordingly. | |
| The following provides release notes you need to know when you upgrade from v8.4.0 to the current version (v{{{ .tidb-version }}}). If you are upgrading from v8.3.0 or earlier versions to the current version, you might also need to check the [release notes](/releases/_index.md) of the intermediate versions. | |
| - TiDB v8.5.0 [compatibility changes](/releases/release-8.5.0.md#compatibility-changes) | |
| - TiDB v8.5.1 [release notes](/releases/release-8.5.1.md) | |
| - TiDB v8.5.2 [release notes](/releases/release-8.5.2.md) | |
| - TiDB v8.5.3 [compatibility changes](/releases/release-8.5.3.md#compatibility-changes) | |
| - TiDB v8.5.4 [compatibility changes](/releases/release-8.5.4.md#compatibility-changes) | |
| - TiDB v8.5.5 [compatibility changes](https://docs.pingcap.com/tidb/stable/release-8.5.5/#compatibility-changes) |
Comment on lines
4
to
8
| <<<<<<< HEAD | ||
| aliases: ['/tidb/dev/sample-application-java','/tidb/dev/dev-guide-sample-application-java'] | ||
| ======= | ||
| aliases: ['/tidb/stable/dev-guide-sample-application-java-jdbc/','/tidb/dev/dev-guide-sample-application-java-jdbc/','/tidbcloud/dev-guide-sample-application-java-jdbc/'] | ||
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)) |
Contributor
There was a problem hiding this comment.
This file contains unresolved merge conflicts in the aliases frontmatter. Please resolve them before merging. The version from the b7469123c6 commit seems more consistent with the new documentation structure.
Suggested change
| <<<<<<< HEAD | |
| aliases: ['/tidb/dev/sample-application-java','/tidb/dev/dev-guide-sample-application-java'] | |
| ======= | |
| aliases: ['/tidb/stable/dev-guide-sample-application-java-jdbc/','/tidb/dev/dev-guide-sample-application-java-jdbc/','/tidbcloud/dev-guide-sample-application-java-jdbc/'] | |
| >>>>>>> b7469123c6 (release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs (#22420)) | |
| aliases: ['/tidb/stable/dev-guide-sample-application-java-jdbc/','/tidb/dev/dev-guide-sample-application-java-jdbc/','/tidbcloud/dev-guide-sample-application-java-jdbc/'] |
qiancai
reviewed
Feb 11, 2026
qiancai
removed
the
do-not-merge/hold
qiancai
approved these changes
Feb 11, 2026
Collaborator
|
/approve |
qiancai
changed the title
Collaborator
|
/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 |
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
2 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.
This is an automated cherry-pick of #22420
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?