Skip to content

*: move Developer docs to an independent doc set#22274

Merged
qiancai merged 12 commits into
pingcap:feature/preview-top-navigationfrom
qiancai:add-toc-develop
Jan 12, 2026
Merged

*: move Developer docs to an independent doc set#22274
qiancai merged 12 commits into
pingcap:feature/preview-top-navigationfrom
qiancai:add-toc-develop

Conversation

@qiancai
Copy link
Copy Markdown
Collaborator

@qiancai qiancai commented Jan 7, 2026

What is changed, added or deleted? (Required)

Moved the developer guide and related content from the main and TiDB Cloud TOCs into a new TOC-develop.md file. Updated references and file locations for Looker Studio, WordPress, and Amazon Bedrock integration guides to reflect the new structure. This change centralizes developer resources and streamlines navigation.

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

@ti-chi-bot ti-chi-bot Bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. area/develop This PR relates to the area of TiDB App development. missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 7, 2026
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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 significantly reorganizes the documentation structure by creating a dedicated table of contents for all developer-focused content. This change aims to enhance the discoverability and accessibility of developer guides and related materials, providing a more coherent and user-friendly experience for developers interacting with TiDB and TiDB Cloud.

Highlights

  • Documentation Restructuring: The developer documentation has been moved from the main and TiDB Cloud Table of Contents (TOCs) into a new, independent TOC-develop.md file, centralizing all developer-related resources.
  • TOC Consolidation: Developer sections have been removed from TOC.md, TOC-tidb-cloud.md, TOC-tidb-cloud-essential.md, and TOC-tidb-cloud-starter.md to streamline navigation and avoid duplication.
  • Path Updates and Clarifications: Integration guides for Looker Studio, WordPress, and Amazon Bedrock have been renamed and their file paths updated to reflect the new documentation structure. Specific notes have been added to the Looker Studio and Amazon Bedrock guides to clarify their applicability to TiDB Cloud only.

🧠 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
Copy Markdown
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 effectively reorganizes the developer documentation by creating a new, independent doc set. The changes centralize developer resources and improve navigation. My review includes a couple of suggestions to enhance clarity and consistency.

Comment thread TOC-develop.md Outdated
Comment thread TOC-develop.md
- [Follower Read](/develop/dev-guide-use-follower-read.md)
- [Stale Read](/develop/dev-guide-use-stale-read.md)
- [HTAP Queries](/develop/dev-guide-hybrid-oltp-and-olap-queries.md)
- Vector Search
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBD

@lilin90 lilin90 added the type/refactor The issue belongs to a refactor work. label Jan 12, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Jan 12, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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

@qiancai
Copy link
Copy Markdown
Collaborator Author

qiancai commented Jan 12, 2026

Merge this PR for preview only. Formal review will be conducted in another PR.

@qiancai qiancai merged commit 4b7a10b into pingcap:feature/preview-top-navigation Jan 12, 2026
5 of 9 checks passed
@qiancai qiancai removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 12, 2026
@qiancai qiancai changed the title [WIP] Move Developer docs to an independent doc set Draft: Move Developer docs to an independent doc set Jan 12, 2026
@lilin90 lilin90 changed the title Draft: Move Developer docs to an independent doc set *:ove Developer docs to an independent doc set Jan 26, 2026
@lilin90 lilin90 changed the title *:ove Developer docs to an independent doc set *: move Developer docs to an independent doc set Jan 26, 2026
@lilin90 lilin90 added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Jan 26, 2026
@lilin90 lilin90 added the translation/doing This PR's assignee is translating this PR. label Jan 26, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jan 26, 2026
@lilin90 lilin90 removed the translation/doing This PR's assignee is translating this PR. label Jan 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/develop This PR relates to the area of TiDB App development. 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.

2 participants