Skip to main content

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.

소스 정보

저장소
openshift/lightspeed-console
최근 소스 활동
2026년 4월 3일 13:01
감지된 SKILL.md 언어
영어
스타
9
포크
39

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
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.
GitHub에서 보기