glossary: add links to alphabets by hfxsd · Pull Request #22634 · pingcap/docs

hfxsd · 2026-03-25T09:45:14Z

Restructure glossary.md for improved navigation: convert many term headings from H3 to H2, add a component for letter navigation, and insert letter anchor links for each section. Also adjust the frontmatter separator/formatting. Add the missing MONITOR keyword to keywords.md.

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

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)?

This PR is translated from:glossary: add links to alphabets docs-cn#21460
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

Restructure glossary.md for improved navigation: convert many term headings from H3 to H2, add a <TabsPanel> component for letter navigation, and insert letter anchor links for each section. Also adjust the frontmatter separator/formatting. Add the missing MONITOR keyword to keywords.md.

gemini-code-assist · 2026-03-25T09:45:44Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 improving the user experience and structural consistency of the documentation. The primary goal is to make the glossary more navigable by introducing alphabetical tab navigation and clearer section headings. Additionally, it ensures the keyword list is up-to-date by including a previously omitted term.

Highlights

Glossary Navigation Improvement: The glossary.md file has been significantly restructured to enhance navigation, including the conversion of many term headings from H3 to H2 for better hierarchy.
Alphabetical Navigation Tabs: A new <TabsPanel> component has been introduced at the top of the glossary to provide quick alphabetical navigation to different sections.
Letter Anchor Links: Anchor links have been added for each letter section within the glossary, allowing direct jumps to terms starting with a specific letter.
Frontmatter Formatting Adjustment: A minor adjustment was made to the frontmatter separator in glossary.md.
Keyword Addition: The missing MONITOR keyword has been added to the keywords.md file.

🧠 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.

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.

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 · 2026-03-25T09:48:34Z

[LGTM Timeline notifier]

Timeline:

2026-03-25 09:48:33.792438406 +0000 UTC m=+348109.828508656: ☑️ agreed by qiancai.

gemini-code-assist

Code Review

This pull request refactors the glossary.md file by introducing a TabsPanel component and adjusting the heading structure for various terms, promoting ### headings to ## and adding <a> tags for letter-based navigation. Additionally, the MONITOR keyword is added to keywords.md. Key feedback for glossary.md includes removing a UTF-8 Byte Order Mark (BOM) character at the beginning of the file for compatibility and ensuring all headings conform to the sentence case rule as specified in the style guide.

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

glossary.md (1)

This line starts with a UTF-8 Byte Order Mark (BOM) character (). This character is invisible in many editors but can cause issues with some Markdown parsers and tools. It's best to remove it for compatibility.

---

References

The style guide emphasizes clarity and readability. Invisible characters like a BOM can lead to unexpected rendering or processing issues, which goes against the principle of clarity. ^(link)

glossary.md (35)

According to the repository style guide, headings should use sentence case (e.g., ## Configure the cluster). This heading and many others in this file are in Title Case. For consistency and to adhere to the style guide, they should be converted to sentence case.

Here are other headings that also need to be changed:

## Baseline Capturing
## Batch Create Table
## Cached Table
## Coalesce Partition
## Column Family (CF)
## Common Table Expression (CTE)
## Continuous Profiling
## Data Definition Language (DDL)
## Data Migration (DM)
## Data Modification Language (DML)
## Development Milestone Release (DMR)
## Disaster Recovery (DR)
## Distributed eXecution Framework (DXF)
## Dynamic Pruning
## Garbage Collection (GC)
## General Availability (GA)
## Global Transaction Identifiers (GTIDs)
## Hybrid Transactional and Analytical Processing (HTAP)
## In-Memory Pessimistic Lock
## Index Merge
## Key Management Service (KMS)
## Key-Value (KV)
## Lightweight Directory Access Protocol (LDAP)
## Lock View
## Long Term Support (LTS)
## Massively Parallel Processing (MPP)
## Online Analytical Processing (OLAP)
## Online Transaction Processing (OLTP)
## Out of Memory (OOM)
## PD Control (pd-ctl)
## Placement Driver (PD)
## Placement Rules
## Point Get
## Point in Time Recovery (PITR)
## Queries Per Second (QPS)
## Quota Limiter
## Raft Engine
## Region Split
## Remote Procedure Call (RPC)
## Request Unit (RU)
## Security Enhanced Mode (SEM)
## Stale Read
## Static Sorted Table / Sorted String Table (SST)
## TiDB Lightning
## TiKV MVCC In-Memory Engine (IME)
## Timestamp Oracle (TSO)
## Top SQL
## Transactions Per Second (TPS)
## Uniform Resource Identifier (URI)
## Universally Unique Identifier (UUID)

Note: Single-word headings, acronyms, and proper names like TiDB or RocksDB do not need to be changed.

## Backup and restore (BR)

References

The style guide specifies that headings should be in sentence case. For example: ## Configure the cluster. ^(link)