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.
Source facts
- Repository
- openshift/lightspeed-console
- Last source activity
- April 3, 2026 at 13:01
- Detected SKILL.md language
- English
- Stars
- 9
- Forks
- 39
Install options
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Review the source files
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
Showing SKILL.md
SKILL.md
Source instructions · Read-only preview- 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.
View on GitHub