update-readme

Solid

Refresh README structure and content using repo context from git-workspace-review

AI & Automation 294 stars 26 forks Updated today MIT

Install

View on GitHub

Quality Score: 95/100

Stars 20%
82
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# README Update Workflow ## When To Use Use this skill whenever the README requires a structural refresh. Run `Skill(sanctum:git-workspace-review)` first to capture repo context and diffs. ## When NOT To Use - Updating inline docs: use doc-updates - Consolidating ephemeral reports: use doc-consolidation ## Required TodoWrite Items 1. `update-readme:language-audit` 2. `update-readme:exemplar-research` 3. `update-readme:outline-aligned` 4. `update-readme:edits-applied` 5. `update-readme:slop-scanned` - AI marker detection via scribe 6. `update-readme:verification-reporting` ## Step 1 - Language Audit (`update-readme:language-audit`) - Confirm `pwd`, `git status -sb`, and the baseline branch for reference. - Detect dominant languages using repository heuristics (manifest files, file counts). - Note secondary languages that influence documentation (e.g., a TypeScript frontend and a Rust backend) so the README can surface both. - Record the method and findings. See `modules/language-audit.md` for detailed detection patterns and commands. ## Step 2 - Exemplar Research (`update-readme:exemplar-research`) - For each primary and secondary language, use web search to locate high-quality READMEs (star count, recency, maintainer activity). - Capture 2-3 exemplar repositories per language and summarize why each is relevant (section order, visuals, quickstart clarity, governance messaging, math exposition, etc.). - Store citations for every exemplar so the final summary references t...

Details

Author
athola
Repository
athola/claude-night-market
Created
6 months ago
Last Updated
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category