regenerate-readme

Solid

Rebuild README.md from current product reality (ROADMAP, AGENTS, design docs) after a load-bearing change or tone refresh, following the repeatable regeneration contract.

Web & Frontend 4 stars 0 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 83/100

Stars 20%

Recency 20%

100

Frontmatter 20%

Documentation 15%

100

Issue Health 10%

License 10%

100

Description 5%

100

Skill Content

# Skill: Regenerate README > Sentinel: `TASKBOARD-SKILL-REGENERATE-README`. Echo this string in your first reply when the orchestrator probes whether the skill loaded. Rebuild [`README.md`](../../../README.md) from the current product reality. README is a narrative document; it drifts whenever code, architecture, or tone changes. This skill captures the contract so the regeneration is repeatable. ## When to invoke - After a load-bearing change to runner / orchestrator / supervisor / skill model that the README must reflect. - After a marketing-tone refresh. - When a periodic system review flags README drift against ROADMAP.md or AGENTS.md. ## Inputs The README must stay in sync with these sources of truth. Read them first; never paraphrase from memory: - [`ROADMAP.md`](../../../ROADMAP.md) - product thesis, themes, hard boundaries. - [`AGENTS.md`](../../../AGENTS.md) - architecture pointers, orchestration philosophy, supervision model. - [`docs/system/architecture/decisions/adr-archive.md`](../../../docs/system/architecture/decisions/adr-archive.md) - load-bearing decisions to honour. - [`docs/quality/design-principles.md`](../../../docs/quality/design-principles.md) - UX contract. - [`docs/system/contracts/protocol-style.md`](../../../docs/system/contracts/protocol-style.md) - Activity Log shape. - [`backend/Endpoints/EndpointMapping.cs`](../../../backend/Endpoints/EndpointMapping.cs) - the actual route surface; never invent endpoints. ## Hard rules These are policy...

Details

Author: agent-orc
Repository: agent-orc/agent-studio
Created: 5 months ago
Last Updated: today
Language: C#
License: Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

writing-project-readme

Use when explicitly invoked to write or fully rewrite a project README that must cover tech stack, architecture, features, and service description in a single document — readable by non-engineers (PM, design, ops, domain experts) as well as developers. Triggers on requests like "write the README", "redo README.md based on the whole project", "make a comprehensive README everyone can understand". Skip for one-section edits, badge tweaks, or generating a CHANGELOG.

1 Updated 1 months ago

douinc

AI & Automation Listed

readme-regen

Regenerate README.md's machine-owned settings region from package.json's contributes.configuration, then run a feature-coverage check that flags drift between the hand-written feature prose and the extension's real contribution points. Use whenever README.md or a `contributes.*` entry in package.json changes. Never rewrites feature prose — it only reports.

7 Updated today

SinnConsulting

Data & Documents Listed

readme-writer

Write, generate, overhaul, or fix a project's README.md (or any "readme", repo front page, or top-level project documentation). Use this skill whenever the user wants to create or improve a README, document a repo, or figure out how to present a codebase to readers — covering libraries and packages, CLI tools, research/ML repos, web apps, services, and developer tooling. Trigger even when the user only says things like "document this project", "write docs for my repo", "make a readme", or points at a codebase and asks how to present it, even if the word "README" never appears.

0 Updated 1 months ago

Punpun1643