-
Notifications
You must be signed in to change notification settings - Fork 709
[WIP] Move Developer docs to an independent doc set #22274
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: feature/preview-top-navigation
Are you sure you want to change the base?
[WIP] Move Developer docs to an independent doc set #22274
Conversation
|
[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 |
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 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
🧠 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
|
61ade27 to
0bc8e24
Compare
There was a problem hiding this 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.
| - [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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBD
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?