update-readme

Regenerate crate READMEs and sync docs site with API coverage data.

15|Updated Feb 24, 2026

Search Tags:#automation #documentation #markdown #readme #crates #docs-site #api-coverage

Ready to run

npx skills add https://github.com/moriyoshi/winterbaume --skill update-readme-moriyoshi

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-readme
Source: https://github.com/moriyoshi/winterbaume/tree/main/.agents/skills/update-readme
Command: npx skills add https://github.com/moriyoshi/winterbaume --skill update-readme-moriyoshi

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Keeps workspace and crate READMEs in sync with the latest API coverage data by regenerating per-service READMEs and updating the docs site.

Core Features & Use Cases

Rebuilds the API-coverage overview from .agents/docs/API_COVERAGE.md and injects it into the workspace README.
Regenerates per-service crate READMEs to reflect implemented vs. pending API operations and updates the docs site accordingly.
Preserves existing content outside the automation scope, enabling safe, incremental documentation updates.

Quick Start

Run the update-readme script to refresh all crate READMEs and the docs site.

Frequently Asked Questions about update-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I keep README documentation in sync with API coverage data?▼

Automating README documentation synchronization involves regenerating per-service crate READMEs and workspace overviews by reading an API coverage file to compute implemented versus pending operations.

What is the best way to automate markdown README updates for multiple service crates?▼

Automating markdown README updates across service crates involves reading an API coverage overview, computing implemented operations, and injecting summaries into workspace and per-crate READMEs.

Does automated documentation regeneration preserve existing markdown content outside the API coverage scope?▼

Automated documentation regeneration preserves existing markdown content outside the API coverage scope, enabling safe, incremental updates to non-service sections while injecting coverage summaries into designated areas.

How does an API coverage overview compute implemented operations for crate READMEs?▼

An API coverage overview computes implemented operations for crate READMEs by reading a tracking file, parsing implemented versus pending API operations, and populating per-crate and overall coverage summaries based on that data.

Can I use a script to update a docs site and workspace README with API coverage at the same time?▼

You can use a script to update a docs site and workspace README with API coverage simultaneously by regenerating per-service crate READMEs and syncing the docs site with current coverage data in one run.