Maintain specialized README.md files for skills and plugin repositories through one deterministic workflow.
Inputs
- Required:
--workspace <path> - Optional:
--repo-glob <glob> - Optional: repeatable
--exclude <path> - Optional:
--apply-fixes - Treat
skills_readme_alignmentas compatibility-only when handling legacy prompts.
Workflow
- Validate the workspace path and discover matching repositories.
- Run the read-only audit first.
- Check README sections, install commands, skill inventory wording, and skills/plugin discoverability rules.
- If the user requested edits, apply bounded fixes with
--apply-fixes. - Re-run the same audit to confirm remaining issues.
- Return the Markdown plus JSON report shape.
Output Contract
- Return Markdown plus JSON with:
run_contextrepos_scannedprofile_assignmentsschema_violationscommand_integrity_issuesfixes_appliedpost_fix_statuserrors
- If there are no issues and no errors, output exactly
No findings.
Guardrails
- Never auto-commit, auto-push, or open a PR.
- Never edit source code, manifests, lockfiles, or CI files.
- Keep edits bounded to
README.mdand explicitly approved snippet insertions intoAGENTS.md. - Do not use this skill for ordinary software project READMEs. Use
maintain-project-readmeinstead.
References
references/output-contract.mdreferences/skills-readme-maintenance-automation-prompts.mdreferences/profile-model.mdreferences/section-schema.mdreferences/discoverability-rules.mdreferences/fix-policies.md