Weekly keywords check: mismatches found
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Start with scripts/check-keywords.py to understand how the check compares keywords.md with the TiDB parser. Add documentation for the 11 listed non-reserved keywords in keywords.md on the affected branch, then run the checker and confirm it reports no mismatches.
Written by the indexing model from the issue text.
Description
Weekly Keywords Check Report
Summary
- master — Keywords check result: ❌ mismatch
- release-8.5 — Keywords check result: ✅ pass
master — 11 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: ASYNC
Missing docs for non-reserved keyword from UnReservedKeyword: AUTO
Missing docs for non-reserved keyword from UnReservedKeyword: COMPLETE
Missing docs for non-reserved keyword from UnReservedKeyword: DELTA
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
Missing docs for non-reserved keyword from UnReservedKeyword: PLACE
Missing docs for non-reserved keyword from UnReservedKeyword: TRANSITIONS
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-28 01:25 UTC
Workflow run: https://github.com/pingcap/docs/actions/runs/36365879902
- Dominant language
- Python
- Stars
- 617
- Forks
- 724
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 366
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pingcap/docs
-
Broken Link DetectedOpen
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Broken Link DetectedOpen
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Maintainers usually reply within 1 day
-
Broken Link DetectedOpen
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day
Similar issues
-
comp/tools duplicate P2 sweeper:risk-compatibility tool/mcp type/bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
NousResearch/hermes-agent#132042 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
deepset-ai/haystack#13092 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
EverMind-AI/Raven#845 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
AstrBotDevs/AstrBot#10340 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
BasedHardware/omi#20401 · 1 comment ·
Maintainers usually reply within 1 day