Skip to content

new nav: minor wording updates for AI docs#22419

Merged
qiancai merged 1 commit intopingcap:feature/preview-top-navigationfrom
qiancai:fix-typo-in-ai-docs
Feb 6, 2026
Merged

new nav: minor wording updates for AI docs#22419
qiancai merged 1 commit intopingcap:feature/preview-top-navigationfrom
qiancai:fix-typo-in-ai-docs

Conversation

@qiancai
Copy link
Collaborator

@qiancai qiancai commented Feb 6, 2026

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.

  • 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
Copy link

ti-chi-bot bot commented Feb 6, 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 assign kissmydb for approval. 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

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 6, 2026
@qiancai qiancai self-assigned this Feb 6, 2026
@qiancai qiancai added the translation/no-need No need to translate this PR. label Feb 6, 2026
@gemini-code-assist
Copy link
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 focuses on refining the AI-related documentation by implementing a series of minor wording updates, grammatical corrections, and formatting improvements. The changes aim to enhance the overall readability, accuracy, and consistency of the guides and examples, making the content more precise and user-friendly for developers and readers.

Highlights

  • Wording and Grammatical Enhancements: Numerous minor wording and grammatical adjustments have been made across various documentation files to improve clarity and consistency. This includes standardizing phrases like 'Open your browser and visit', correcting 'easy to connect' to 'easily connect', and refining conditional phrasing from 'may' to 'might'.
  • Punctuation and Formatting Consistency: Punctuation has been standardized, particularly by adding periods to the end of enumerated list items. Headings have also been corrected for consistent capitalization, such as '# Image search' becoming '# Image Search'.
  • Typographical Corrections: A specific typo, 'dbass', has been corrected to 'dbaas' in the ai/guides/tables.md file, ensuring accuracy in technical terms.
  • Content Clarification and Link Updates: Descriptions for SQL statement execution (db_execute) have been broadened to include DML or DDL. Internal documentation links for transactions have been updated, and comments in auto-embedding SQL examples have been improved for better guidance. Capitalization for 'Full-text search' has been standardized, and 'TiDB AI SDK' has been explicitly linked to 'The TiDB Python SDK [pytidb]'.

🧠 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
  • ai/examples/fulltext-search-with-pytidb.md
    • Changed 'Open the browser and visit' to 'Open your browser and visit'.
  • ai/examples/hybrid-search-with-pytidb.md
    • Added a period to the end of the sentence 'Open your browser and visit http://localhost:8501'.
  • ai/examples/image-search-with-pytidb.md
    • Changed 'Open http://localhost:8501 in your browser.' to 'Open your browser and visit http://localhost:8501.'
    • Added periods to the end of enumerated list items in 'Step 7. Search'.
  • ai/examples/memory-with-pytidb.md
    • Changed 'Visit http://localhost:8501 in your browser' to 'Open your browser, visit http://localhost:8501'.
    • Corrected 'easy to connect' to 'easily connect'.
  • ai/examples/rag-with-pytidb.md
    • Added a period to the end of the sentence 'Open the browser and visit http://localhost:8501'.
  • ai/examples/text2sql-with-pytidb.md
    • Added a period to the end of the sentence 'Open the browser and visit http://localhost:8501'.
  • ai/guides/auto-embedding.md
    • Changed 'Auto embedding' to 'The Auto Embedding feature'.
  • ai/guides/connect.md
    • Changed 'A connection dialog is displayed with' to 'A connection dialog is displayed, with'.
  • ai/guides/image-search.md
    • Changed heading '# Image search' to '# Image Search'.
  • ai/guides/raw-queries.md
    • Changed 'As list of dict' to 'As a list of dictionaries'.
  • ai/guides/reranking.md
    • Changed 'rerank model' to 'reranking model'.
    • Added periods to the end of enumerated list items for 'Initial Retrieval' and 'Reranking'.
    • Changed 'use reranker models' to 'use reranking models'.
    • Changed 'Here are some examples to use reranker models' to 'The following examples show how to use reranking models'.
  • ai/guides/tables.md
    • Corrected typo 'dbass' to 'dbaas' in two instances.
  • ai/guides/transactions.md
    • Updated internal documentation links for 'TiDB Develop Guide - Transaction' and 'TiDB Docs- SQL Reference - Transactions'.
  • ai/guides/vector-search-full-text-search-python.md
    • Changed 'Full-text search' to 'full-text search' (lowercase 'f').
  • ai/guides/vector-search-full-text-search-sql.md
    • Changed 'Full-text search' to 'full-text search' (lowercase 'f').
    • Changed 'English contents' to 'English content'.
  • ai/guides/vector-search-hybrid-search.md
    • Changed 'Full-text search' to 'full-text search' (lowercase 'f').
    • Changed 'weighted sum:' to 'a weighted sum:'.
  • ai/guides/vector-search.md
    • Changed 'shows you how to use' to 'shows how to use'.
    • Changed 'may decrease' to 'might decrease' and 'may reduce' to 'might reduce'.
  • ai/integrations/embedding-openai-compatible.md
    • Changed 'TiDB AI SDK' to 'The TiDB Python SDK [pytidb]'.
  • ai/integrations/tidb-mcp-claude-desktop.md
    • Changed heading '# Integrate TiDB MCP Server with Claude Desktop' to '# Get started with Claude Desktop and TiDB MCP Server'.
  • ai/integrations/tidb-mcp-cursor.md
    • Changed 'Cursor Editor' to 'Cursor'.
    • Changed 'may not exist' to 'might not exist'.
  • ai/integrations/tidb-mcp-server.md
    • Changed 'Execute data modification SQL statements' to 'Execute SQL statements (DML or DDL)'.
  • ai/integrations/vector-search-auto-embedding-jina-ai.md
    • Changed 'run similarity search' to 'run a similarity search'.
  • ai/integrations/vector-search-auto-embedding-overview.md
    • Improved comments regarding vector column dimension matching in auto-embedding SQL examples.
    • Changed 'HuggingFace Embeddings' to 'Hugging Face Embeddings'.
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.

@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Feb 6, 2026
@qiancai qiancai added type/refactor The issue belongs to a refactor work. missing-translation-status This PR does not have translation status info. and removed missing-translation-status This PR does not have translation status info. labels Feb 6, 2026
Copy link
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 introduces a series of minor but valuable wording updates across the AI documentation. The changes include fixing typos, correcting grammar, improving sentence structure, and ensuring consistent terminology. These edits enhance the clarity and readability of the documents. I have one minor suggestion to ensure full alignment with the repository's style guide regarding the use of the second person.

@qiancai qiancai merged commit b32a66f into pingcap:feature/preview-top-navigation Feb 6, 2026
4 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR. type/refactor The issue belongs to a refactor work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant