pingcap / pingcap/docs-cn

Weekly keywords check: mismatches found

Open Beginner friendly
#21,912 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 — 6 issue(s)

Comparing keywords.md
against TiDB parser (master):

Missing docs for non-reserved keyword from UnReservedKeyword: ALERT
Missing docs for non-reserved keyword from UnReservedKeyword: AUTO
Missing docs for non-reserved keyword from UnReservedKeyword: FAST
Missing docs for non-reserved keyword from UnReservedKeyword: IMMEDIATE
Missing docs for non-reserved keyword from UnReservedKeyword: MATERIALIZED
Missing docs for non-reserved keyword from UnReservedKeyword: OPERATE

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-09-02 04:22 UTC
Workflow run: https://github.com/pingcap/docs-cn/actions/runs/33590517890

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

Update keywords.md on the master and release-8.5 branches using the mismatches listed in the report. Start by reading scripts/check-keywords.py and the linked parser keyword definitions, then add documentation for every reported keyword. Done means the keyword check passes for both affected branches.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.