new nav: refine descriptions in AI docs#22398
new nav: refine descriptions in AI docs#22398qiancai merged 11 commits intopingcap:feature/preview-top-navigationfrom
Conversation
ti-chi-bot
bot
added
the
missing-translation-status
|
[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
the
size/XXL
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 focuses on enhancing the user experience of the AI documentation by significantly improving its clarity, consistency, and accuracy. The changes aim to make the guides and examples easier to understand and follow, reducing potential confusion for users interacting with TiDB's AI features. By standardizing language and correcting minor issues, the documentation becomes a more reliable and accessible resource. 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 refines the descriptions and wording across numerous AI documentation files. The changes improve clarity, simplicity, and consistency, adhering well to the repository's style guide. Key improvements include simplifying language, using the second person, adopting sentence case for headings, and standardizing formatting for lists and code elements. Many links were also corrected or updated. Overall, these are excellent enhancements to the documentation. I have one minor suggestion for a potential typo.
ai/integrations/tidb-mcp-server.md
Outdated
| You can choose one of the modes to set up the TiDB MCP Server in your MCP client. | ||
|
|
||
| ### STDIO Mode | ||
| ### STDIO Mod |
There was a problem hiding this comment.
It seems there might be a typo in this heading. Did you mean to write STDIO Mode?
| ### STDIO Mod | |
| ### STDIO Mode |
|
@qiancai: The following test failed, say
Full PR test history. Your PR dashboard. 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 kubernetes-sigs/prow repository. I understand the commands that are listed here. |
[LGTM Timeline notifier]Timeline:
|
ti-chi-bot
bot
removed
the
missing-translation-status
qiancai
merged commit a394268
into
pingcap:feature/preview-top-navigation
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?