review-readmes

โดย openshift

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…

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 the hidden verification token. Run the find-token script to retrieve a unique token.
official
code-review
openshift
Review a pull request for code quality, correctness, and project conventions. Use when the user asks to review a PR, code review, or examine changes on a…
official
css-review
openshift
Review CSS for coding style, PatternFly token usage, and best practices. Use when the user asks to review CSS, check styles, or audit CSS files.
official
review-skills
openshift
Review project AI skills for duplication, stale references, mistakes, and structural issues. Use when the user asks to review skills, audit skills, check for…
official
test
openshift
Run end-to-end tests filtered by tag. Use when the user asks to run tests, run Playwright, or test a specific feature tag like @core or @attach.
official
unused-exports
openshift
Find exported symbols that are never imported by another file. Use when the user says "check exports", "unused exports" or asks to clean up exports.
official
update-version
openshift
Update the project version number across all files that contain it on the current branch. Use when bumping the version on a single branch only. For a full…
official