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.
Informações da origem
- Repositório
- openshift/lightspeed-console
- Última atividade na origem
- 3 de abril de 2026 às 13:01
- Idioma detectado do SKILL.md
- inglês
- Estrelas
- 10
- Forks
- 37
Opções de instalação
Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.
Revise os arquivos de origem
Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.
Exibindo SKILL.md
SKILL.md
Instruções da origem · Visualização somente leitura- 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 no GitHub