feature tables: support sticky headers#22967
Conversation
There was a problem hiding this comment.
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)
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)
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
- Avoid passive voice overuse. (link)
ai/guides/raw-queries.md (36)
Prefer present tense ("returns") over future tense ("will return") to adhere to the style guide.
References
- Prefer present tense unless describing historical behavior. (link)
ai/guides/raw-queries.md (84)
Prefer present tense ("returns") over future tense ("will return") to adhere to the style guide.
References
- Prefer present tense unless describing historical behavior. (link)
ai/guides/vector-search.md (341)
Use active voice and present tense to improve clarity and readability.
References
- Avoid passive voice overuse. (link)
ai/guides/vector-search-full-text-search-python.md (118)
Use the hyphenated form "full-text" instead of "fulltext" to maintain terminology consistency across the documentation.
References
- Use consistent terminology. (link)
ai/guides/connect.md (49)
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)
Avoid using the auxiliary verb "can" and prefer direct present tense to improve clarity and flow.
References
- Prefer present tense unless describing historical behavior. (link)
ai/examples/auto-embedding-with-pytidb.md (11)
Use backticks for class names like VectorField to adhere to the style guide.
References
- Code snippets, command names, options, and paths should be in backticks. (link)
best-practices/best-practices-on-public-cloud.md (140)
Avoid passive voice ("it is recommended to deploy") and use active voice ("deploy") to make the instruction more direct and clear.
References
- Avoid passive voice overuse. (link)
br/backup-and-restore-overview.md (26)
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
- Avoid passive voice overuse. (link)
best-practices/uuid.md (25)
Rewrite sentences using active voice and second person ("you") to improve clarity and flow.
References
- Avoid passive voice overuse. (link)
best-practices/pd-scheduling-best-practices.md (257)
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)
Avoid passive voice ("is not recommended") and use active voice ("We do not recommend") to make the guideline clearer.
References
- Avoid passive voice overuse. (link)
br/br-compact-log-backup.md (30)
Avoid passive voice ("is supported", "It is recommended to use") and use active voice to make the instruction clearer.
References
- Avoid passive voice overuse. (link)
_docHome.md (9)
Add an Oxford comma before "and" in the list to maintain punctuation consistency across the documentation.
ai/quickstart-via-python.md (20)
Use parallel verb structures ("create ... or use") to improve grammatical correctness and readability.
ai/quickstart-via-sql.md (25)
Add the missing article "the" before "steps" to correct the grammar.
ai/reference/vector-search-changelogs.md (11)
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)
Avoid future tense ("will be embedded") and use present tense ("is automatically embedded") to adhere to the style guide.
References
- Prefer present tense unless describing historical behavior. (link)
|
[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 |
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?