review-readmes

Überprüfe alle README.md-Dateien im Repository auf Tippfehler, Fehler und veraltete Informationen. Verwende dies, wenn der Benutzer darum bittet, READMEs zu überprüfen, die Dokumentationsgenauigkeit zu prüfen oder…

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.

Mehr Skills von openshift

openshift-docs
openshift
Durchsuchen und Lesen der OpenShift Container Platform-Dokumentation im Markdown-Format. Verwenden, wenn der Benutzer nach OpenShift-Funktionen, Konfiguration, Installation, … fragt.
triage-leaked-infra
openshift
Bewerten Sie, ob eine AWS-VPC oder eine Infrastruktur aus HyperShift CI sicher gelöscht werden kann. Verwenden Sie dies, wenn der Benutzer eine saubere geleakte Ausgabe einfügt und fragt: „Kann ich das löschen?“, „Ist…
openshift-expert
openshift
OpenShift-Plattform- und Kubernetes-Experte mit fundierten Kenntnissen in Cluster-Architektur, Operatoren, Netzwerk, Speicher, Fehlerbehebung und CI/CD-Pipelines. Nutzen…
Konflux Archived PipelineRuns
openshift
Greift auf archivierte Konflux PipelineRuns, TaskRuns und Pod-Logs über KubeArchive zu. Wird automatisch angewendet, wenn Konflux PipelineRun-Ergebnisse überprüft, untersucht…
backport
openshift
Commits oder PRs vom Hauptzweig in einen Release-Zweig zurückportieren. Verwenden, wenn der Benutzer darum bittet, Änderungen zwischen Zweigen zurückzuportieren, zu cherry-picken oder zu portieren, oder beim Beheben von…
rebase
openshift
Rebase den aktuellen Branch auf seinen Basis-Branch, löse alle Konflikte und stelle sicher, dass Lint, i18n und Build erfolgreich durchlaufen. Verwende dies, wenn der Benutzer darum bittet, zu rebasen, zu aktualisieren oder zu synchronisieren…
Build CPO Image
openshift
Erstellen und Pushen des control-plane-operator-Container-Images. Wird automatisch angewendet, wenn CPO-Änderungen getestet werden, die ein Deployment auf einem Live-Cluster erfordern.
find-complexity
openshift
Findet Funktionen und Methoden mit hoher zyklomatischer Komplexität, übermäßiger Länge oder zu vielen Parametern. Verwenden, wenn der Benutzer bittet, komplexen Code, Komplexität zu finden…