review-readmes
作者: openshift
審查儲存庫中所有 README.md 檔案的拼寫錯誤、錯誤及過時資訊。當使用者要求審查 README、檢查文件準確性或…時使用。
npx skills add https://github.com/openshift/lightspeed-console --skill review-readmesReview READMEs
Audit every README.md in the repository for language quality and factual
accuracy against the current codebase.
Step 1 — Collect README files
Find all README files:
find . -name 'README.md' -not -path '*/node_modules/*'
Read each file in full.
Step 2 — Check language quality
For each README, look for:
- Spelling mistakes and typos
- Grammatical errors
- Awkward phrasing or unclear sentences
- Broken Markdown formatting
- Unnecessary verbosity — tighten wordy passages without losing meaning
Step 3 — Cross-reference with the codebase
Verify that claims in the READMEs still hold by checking the actual code. Do not guess — confirm every claim against the source.
Step 4 — Fix
Apply all fixes directly to the README files. For each file, briefly summarize what was changed and why.