pingcap / pingcap/docs-cn

Weekly keywords check: mismatches found

Open Beginner friendly
#21,753 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.8k
Forks
1.2k
Avg merge
1d 16h
Merged PRs (30d)
31

Description

Weekly Keywords Check Report

Summary

  • master — Keywords check result: ❌ mismatch
  • release-8.5 — Keywords check result: ❌ mismatch

master — 3 issue(s)

Comparing keywords.md
against TiDB parser (master):

Missing docs for non-reserved keyword from UnReservedKeyword: OLD
Missing docs for non-reserved keyword from UnReservedKeyword: RETAIN
Missing docs for non-reserved keyword from UnReservedKeyword: UUID

release-8.5 — 7 issue(s)

Comparing keywords.md
against TiDB parser (release-8.5):

Missing docs for reserved keyword: LATERAL
Missing docs for non-reserved keyword from UnReservedKeyword: RULE
Missing docs for non-reserved keyword from UnReservedKeyword: TIMEOUT
Missing docs for non-reserved keyword from UnReservedKeyword: VECTOR
Missing docs for non-reserved keyword from TiDBKeyword: DISTRIBUTE
Missing docs for non-reserved keyword from TiDBKeyword: DISTRIBUTION
Missing docs for non-reserved keyword from TiDBKeyword: DISTRIBUTIONS

How to fix

Update keywords.md on the affected branch to match the current TiDB parser keywords.
See check-keywords.py for details.


Run date: 2026-07-01 05:41 UTC
Workflow run: https://github.com/pingcap/docs-cn/actions/runs/28496249317

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect keywords.md on master and release-8.5, then read scripts/check-keywords.py to understand the reported comparison. Add the listed missing keywords on each affected branch and rerun the keyword check. Done means both branches match their referenced TiDB parser keywords without reported mismatches.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
84/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.