Skip to content

Conversation

@ti-chi-bot
Copy link
Member

This is an automated cherry-pick of #21821

First-time contributors' checklist

What is changed, added or deleted? (Required)

  • Remove reference manual links for functions for which we have our own docs.
  • Keep links for functions/operators that are not explained in the TiDB docs yet
  • We can keep a link at the top linking to the corresponding page in the MySQL Reference Manual like this: TiDB supports most of the user-level [locking functions](https://dev.mysql.com/doc/refman/8.0/en/locking-functions.html) available in MySQL 8.0.

This was done with sed -E -i -e 's/(^#* )\[(.*)\].*$/\1\2/' path/to/file.md

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 added area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. type/enhancement The issue or PR belongs to an enhancement. labels Nov 19, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello @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 streamlines the TiDB documentation by removing redundant external links to the MySQL Reference Manual for functions and operators that are already comprehensively documented within TiDB's own guides. This change aims to provide a more self-contained and consistent user experience, ensuring that users are directed to the most relevant and up-to-date information directly within the TiDB documentation portal. This improves the overall quality and navigability of the documentation.

Highlights

  • Documentation Link Cleanup: External MySQL Reference Manual links have been removed from function and operator headings in the TiDB documentation where TiDB provides its own comprehensive documentation.
  • Improved User Experience: This change aims to streamline the user experience by directing readers to TiDB's internal documentation for covered topics, reducing reliance on external references.
  • Targeted Updates: Only links for functions and operators already explained in TiDB's own documentation were removed, while external links for un-documented items were retained.
  • Automated Process: The changes were applied using a sed command, indicating an automated approach to maintain consistency across documentation files.
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

@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 removes external links to the MySQL Reference Manual from function headings in several documentation files. This change improves readability by decluttering headings and centralizing the reference link at the top of each page. The changes are consistent and correctly implemented according to the pull request's description. The documentation is now cleaner and easier to navigate. I have no further suggestions.

@qiancai
Copy link
Collaborator

qiancai commented Nov 19, 2025

/approve

@ti-chi-bot
Copy link

ti-chi-bot bot commented Nov 19, 2025

[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

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 the approved label Nov 19, 2025
@ti-chi-bot ti-chi-bot bot merged commit f3b56b9 into pingcap:release-8.5 Nov 19, 2025
9 checks passed
@ti-chi-bot ti-chi-bot bot deleted the cherry-pick-21821-to-release-8.5 branch November 19, 2025 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. type/enhancement The issue or PR belongs to an enhancement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants