glossary: add links to alphabets (#22634)#22635
glossary: add links to alphabets (#22634)#22635ti-chi-bot[bot] merged 3 commits intopingcap:release-8.5from
Conversation
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.
ti-chi-bot
added
contribution
Summary of ChangesHello, 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 significantly enhances the usability and completeness of the documentation by improving the navigation within the glossary and updating the list of keywords. The changes aim to make it easier for users to find specific terms and ensure the keyword list is up-to-date, thereby improving the overall documentation experience. Highlights
🧠 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 AssistThe 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
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 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. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates glossary.md by introducing an alphabetical tab panel for navigation and making section headings anchorable. It also adds the 'MONITOR' keyword to keywords.md. A review comment points out that an unnecessary Byte Order Mark (BOM) was added to glossary.md, which should be removed to prevent potential parsing issues.
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hfxsd The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
3 participants
This is an automated cherry-pick of #22634
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
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)?
Do your changes match any of the following descriptions?