Skip to content

feature tables: support sticky headers#22967

Open
qiancai wants to merge 1 commit into
pingcap:release-8.5from
qiancai:add-sticky-header
Open

feature tables: support sticky headers#22967
qiancai wants to merge 1 commit into
pingcap:release-8.5from
qiancai:add-sticky-header

Conversation

@qiancai
Copy link
Copy Markdown
Collaborator

@qiancai qiancai commented May 29, 2026

What is changed, added or deleted? (Required)

Fix #21276 by adding sticky headers to the target table and supporting the sticky header feature in pingcap/website-docs#706

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)

What is the related PR or file 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 missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/develop This PR relates to the area of TiDB App development. labels May 29, 2026
@qiancai qiancai changed the base branch from master to release-8.5 May 29, 2026 01:59
@ti-chi-bot ti-chi-bot Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels May 29, 2026
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 introduces a comprehensive new 'TiDB for AI' documentation section covering vector, full-text, and hybrid search capabilities using the pytidb Python SDK, alongside updates to various table of contents, best practices, and backup/restore guides. The review feedback focuses on improving documentation quality and style guide compliance, including fixing a broken anchor link, replacing hardcoded strings with template variables, correcting grammatical and punctuation errors, and consistently applying active voice and present tense.

I am having trouble creating individual review comments. Click here to see my feedback.

ai/integrations/vector-search-auto-embedding-overview.md (134)

medium

Fix the broken anchor link for VEC_EMBED_COSINE_DISTANCE(). It should point to #vec_embed_cosine_distance instead of #embed_text.

best-practices/ddl-introduction.md (17)

low

Avoid passive voice ("a specific method is used to ensure") and use active voice ("TiDB uses a specific method to ensure") to make the explanation clearer.

References
  1. Avoid passive voice overuse. (link)

ai/guides/raw-queries.md (36)

low

Prefer present tense ("returns") over future tense ("will return") to adhere to the style guide.

References
  1. Prefer present tense unless describing historical behavior. (link)

ai/guides/raw-queries.md (84)

low

Prefer present tense ("returns") over future tense ("will return") to adhere to the style guide.

References
  1. Prefer present tense unless describing historical behavior. (link)

ai/guides/vector-search.md (341)

low

Use active voice and present tense to improve clarity and readability.

References
  1. Avoid passive voice overuse. (link)

ai/guides/vector-search-full-text-search-python.md (118)

low

Use the hyphenated form "full-text" instead of "fulltext" to maintain terminology consistency across the documentation.

References
  1. Use consistent terminology. (link)

ai/guides/connect.md (49)

low

Use the template variable {{{ .starter }}} instead of the hardcoded "TiDB Cloud Starter" to maintain consistency with the repository's templating system.

analyze-slow-queries.md (103)

low

Avoid using the auxiliary verb "can" and prefer direct present tense to improve clarity and flow.

References
  1. Prefer present tense unless describing historical behavior. (link)

ai/examples/auto-embedding-with-pytidb.md (11)

low

Use backticks for class names like VectorField to adhere to the style guide.

References
  1. Code snippets, command names, options, and paths should be in backticks. (link)

best-practices/best-practices-on-public-cloud.md (140)

low

Avoid passive voice ("it is recommended to deploy") and use active voice ("deploy") to make the instruction more direct and clear.

References
  1. Avoid passive voice overuse. (link)

br/backup-and-restore-overview.md (26)

low

Avoid passive voice ("It is not recommended to back up") and use active voice ("Do not back up") to make the restriction more direct and clear.

References
  1. Avoid passive voice overuse. (link)

best-practices/uuid.md (25)

low

Rewrite sentences using active voice and second person ("you") to improve clarity and flow.

References
  1. Avoid passive voice overuse. (link)

best-practices/pd-scheduling-best-practices.md (257)

low

Use "First" instead of "Firstly" to adhere to standard technical writing guidelines, and add a comma after "Then".

br/br-checkpoint-restore.md (65-67)

low

Avoid passive voice ("is not recommended") and use active voice ("We do not recommend") to make the guideline clearer.

References
  1. Avoid passive voice overuse. (link)

br/br-compact-log-backup.md (30)

low

Avoid passive voice ("is supported", "It is recommended to use") and use active voice to make the instruction clearer.

References
  1. Avoid passive voice overuse. (link)

_docHome.md (9)

low

Add an Oxford comma before "and" in the list to maintain punctuation consistency across the documentation.

ai/quickstart-via-python.md (20)

low

Use parallel verb structures ("create ... or use") to improve grammatical correctness and readability.

ai/quickstart-via-sql.md (25)

low

Add the missing article "the" before "steps" to correct the grammar.

ai/reference/vector-search-changelogs.md (11)

low

Use "or later" instead of ">= " to match the standard style for version references in the documentation.

ai/guides/vector-search-hybrid-search.md (120-122)

low

Avoid future tense ("will be embedded") and use present tense ("is automatically embedded") to adhere to the style guide.

References
  1. Prefer present tense unless describing historical behavior. (link)

github-actions Bot pushed a commit to qiancai/pingcap-docsite-preview that referenced this pull request May 29, 2026
@qiancai qiancai changed the title docs: add documentation for ADMIN ALTER DDL JOBS command (#19492) (#1… feature table: support sticky headers May 29, 2026
@qiancai qiancai changed the title feature table: support sticky headers feature tables: support sticky headers May 29, 2026
@qiancai qiancai self-assigned this May 29, 2026
@qiancai qiancai added the translation/doing This PR's assignee is translating this PR. label May 29, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label May 29, 2026
@qiancai qiancai added needs-cherry-pick-master Should cherry pick this PR to master branch. 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 May 29, 2026
@qiancai qiancai closed this May 29, 2026
@qiancai qiancai reopened this May 29, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 29, 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

github-actions Bot pushed a commit to qiancai/pingcap-docsite-preview that referenced this pull request May 29, 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. needs-cherry-pick-master Should cherry pick this PR to master branch. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The "basic-features" matrix is too long and unreadable

1 participant