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.
Datos de origen
- Repositorio
- openshift/lightspeed-console
- Última actividad en el origen
- 3 de abril de 2026 a las 13:01
- Idioma detectado de SKILL.md
- inglés
- Estrellas
- 10
- Forks
- 37
Opciones de instalación
De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.
Revisa los archivos de origen
Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.
Mostrando SKILL.md
SKILL.md
Instrucciones de origen · Vista previa de solo lectura- 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.
Ver en GitHub