openshift/review-readmes
.cursor/skills/review-readmes/SKILL.md
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.
$ install --global
skillsauthnpx skillsauth add openshift/lightspeed-console review-readmesInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 17, 2026, 10:32 AM4.1s1 file scanned
SKILL.md
- name:
- review-readmes
- description:
- >-
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.
Related Skills
openshift/update-version
data-ai
VerifiedTrustedCommunity
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 multi-branch release, use the release skill instead.
8SKILL.mdUpdated Apr 17, 2026
openshift/test
testing
VerifiedTrustedCommunity
Run Cypress tests filtered by tag. Use when the user asks to run tests, run Cypress, or test a specific feature tag like @core or @attach.
8SKILL.mdUpdated Apr 17, 2026
openshift/review-skills
testing
VerifiedTrustedCommunity
Review project AI skills for duplication, stale references, mistakes, and structural issues. Use when the user asks to review skills, audit skills, check for duplicate skills, or verify skill quality.
8SKILL.mdUpdated Apr 17, 2026
openshift/release
tools
VerifiedTrustedCommunity
Bump the project version across all release branches and commit the changes. Use when the user asks to do a release or update the version on all branches.
8SKILL.mdUpdated Apr 17, 2026