review-readmes
Review all README.md files in the repo for typos, errors, and outdated information. Use when the user asks to review READMEs, check documentation accuracy, or audit docs.
来源信息
- 仓库
- openshift/lightspeed-console
- 最近来源活动
- 2026年4月3日 13:01
- 检测到的 SKILL.md 语言
- 英语
- 星标
- 9
- Forks
- 39
安装方式
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
检查来源文件
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
正在显示 SKILL.md
SKILL.md
来源说明 · 只读预览- name
- review-readmes
- description
- Review all README.md files in the repo for typos, errors, and outdated information. Use when the user asks to review READMEs, check documentation accuracy, or audit docs.
# Review 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:
```sh
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.
在 GitHub 查看