review-readmes

Проверить все файлы README.md в репозитории на опечатки, ошибки и устаревшую информацию. Использовать, когда пользователь просит проверить README, точность документации или…

npx skills add https://github.com/openshift/lightspeed-console --skill review-readmes

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:

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.

Больше skills от openshift

openshift-expert
openshift
Эксперт по платформе OpenShift и Kubernetes с глубокими знаниями архитектуры кластеров, операторов, сетей, хранилищ, устранения неполадок и CI/CD-пайплайнов. Используйте…
official
find-token
openshift
Найти скрытый верификационный токен. Запустите скрипт find-token, чтобы получить уникальный токен.
official
code-review
openshift
Проверить пул-реквест на качество кода, корректность и соответствие стандартам проекта. Используется, когда пользователь просит провести ревью PR, проверить код или изучить изменения в…
official
css-review
openshift
Проверка CSS на соответствие стилю кодирования, использование токенов PatternFly и лучшие практики. Используйте, когда пользователь просит проверить CSS, оценить стили или провести аудит CSS-файлов.
official
review-skills
openshift
Проверка AI-навыков проекта на дублирование, устаревшие ссылки, ошибки и структурные проблемы. Используется, когда пользователь просит проверить навыки, провести аудит навыков, проверить на…
official
test
openshift
Запустить сквозные тесты, отфильтрованные по тегу. Используйте, когда пользователь просит запустить тесты, запустить Playwright или протестировать конкретный тег функции, например @core или @attach.
official
unused-exports
openshift
Находит экспортированные символы, которые никогда не импортируются другим файлом. Используется, когда пользователь говорит «проверить экспорт», «неиспользуемый экспорт» или просит очистить экспорт.
official
update-version
openshift
Обновить номер версии проекта во всех файлах, содержащих его, на текущей ветке. Используйте только при повышении версии на одной ветке. Для полного…
official