update-readme

Solid

Update README.md and SPEC.md based on docs/docs/concepts/ and docs/docs/ directories. Use when documentation sources change and README or the reimplementation specification (SPEC.md) need to reflect the latest state.

Testing & QA 47 stars 4 forks Updated today MIT

Install

View on GitHub

Quality Score: 86/100

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

Skill Content

# Update README Launch an agent to update README.md and SPEC.md based on current project documentation. ## Instructions Use the Agent tool to spawn an agent with the following parameters: - **subagent_type**: `general-purpose` - **model**: `sonnet` - **mode**: `default` - **description**: `"Update README and SPEC from docs"` Use the following as the agent prompt: ~~~ You are a documentation writer for the CAFleet project. Your job is to keep two maintained targets in sync with the current content of docs/docs/concepts/ and docs/docs/: README.md and SPEC.md (the reimplementation specification). ## Workflow 1. Read all docs/docs/concepts/*.md files (use Glob to enumerate) for the canonical architecture 2. Discover and read all pages under docs/docs/ (use Glob to find them) 3. Read the rspress sidebar source (the `docs/docs/**/_meta.json` files) for the docs-site section layout, then read the current README.md 4. Sync README.md's thin surface: align the pitch paragraph with the hero tagline in docs/docs/index.md's frontmatter, the Install block with the Install section of docs/docs/quickstart.md, and the Documentation links with the nav 5. Read the current SPEC.md (the reimplementation specification, at the repo root) 6. Reconcile SPEC.md against the source materials per the "SPEC.md Maintenance" rules below, updating only where the contract surfaces have drifted ## README Structure README.md is a thin entry point with exactly four surfaces, in order: 1. **Title, demo...

Details

Author
himkt
Repository
himkt/cafleet
Created
4 months ago
Last Updated
today
Language
Rust
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

readme-agents

Sync AGENTS.md (for agents) and README.md (for humans) with the codebase's current tools, layout, and usage. Use when either drifts from the project's actual state.

3 Updated 3 days ago
fmind
AI & Automation Listed

readme-editor

Create or edit a project's landing documentation set — README.md, AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, and llms.txt — by first deciding which artifacts the repo actually needs, then grilling the user one question at a time with recommended defaults, building a compact README map, using official hyperlinks for named tools and technologies, and only then writing. Inspects the repo before asking anything discoverable. Use when the user wants to create, write, edit, rewrite, audit, polish, or "fix up" a README, AGENTS.md, CLAUDE.md, Copilot instructions, llms.txt, or any project landing/onboarding docs.

0 Updated 2 days ago
YosefHayim
AI & Automation Solid

rc-readme

Creates or updates a project README by analyzing the real codebase, then rewriting README.md with accurate, evidence-based content — or guides writing/improving a README by hand with templates and guidance matched to audience and project type (open source, personal, internal, config). Use when generating a README from scratch, refreshing an outdated one, syncing docs after features land, or drafting/reviewing a README manually. Do not use for API reference files (use rc-openapi or rc-postman), changelog generation, or editing source code.

19 Updated 2 weeks ago
rodolfochicone