ClawKit Logo
ClawKitReliability Toolkit
Back to Registry
Official Verified

update-readme

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

skill-install — Terminal

Install via CLI (Recommended)

clawhub install openclaw/skills/skills/athola/nm-sanctum-update-readme
Or

Night Market Skill — ported from claude-night-market/sanctum. For the full experience with agents, hooks, and commands, install the Claude Code plugin.

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 them explicitly.

See modules/exemplar-research.md for search query patterns and evaluation criteria.

Step 3 - Outline Alignment (update-readme:outline-aligned)

  • Compare current README headings (rg -n '^#' README.md) against patterns observed in exemplars.
  • Draft a target outline covering: value proposition, installation, quickstart, deeper usage/configuration, architecture/feature highlights, performance or math guarantees, documentation links, contribution/governance, roadmap/status, and licensing/security notes.
  • validate internal documents (docs/, specs/, wiki, commands/) are mapped to the relevant sections so the README anchors them with context-sensitive links.

Metadata

Author@athola
Stars4473
Views0
Updated2026-05-01
View Author Profile
AI Skill Finder

Not sure this is the right skill?

Describe what you want to build — we'll match you to the best skill from 16,000+ options.

Find the right skill
Add to Configuration

Paste this into your clawhub.json to enable this plugin.

{
  "plugins": {
    "official-athola-nm-sanctum-update-readme": {
      "enabled": true,
      "auto_update": true
    }
  }
}
Safety NoteClawKit audits metadata but not runtime behavior. Use with caution.