readme

Solid

Create or update the repository's README — scan the codebase and document it with a title, short description, a project list, an architecture mermaid diagram with notes, an infrastructure (cloud tools) section, a local development setup guide, per-project sections (monorepo or polyrepo), and the important task-runner commands. Follows the documentation-standards skill.

DevOps & Infrastructure 1 stars 0 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 78/100

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

Skill Content

# markdown:readme — Document the repo in its README Scan the repository and write (or update) its **README**, following the **documentation-standards** skill (writing style, tables, and the mermaid diagram rules). Default the target to the current repo root; if `$ARGUMENTS` names a directory, operate on `<dir>`. Update an **existing** readme in place — preserve its filename and casing (`README.md` / `readme.md`); otherwise create `README.md`. ## Required sections (in this order) The README must contain these, top to bottom: 1. **Title** — the project name as the `#` H1. 2. **Short description** — one or two sentences on what the project is and does. 3. **List of projects** — every project/package in the repo (a table for a monorepo; a single entry for a polyrepo). 4. **Architecture** — a `mermaid` diagram of how the projects/services fit together, plus the important notes a reader needs (boundaries, data flow, key decisions). 5. **Infrastructure** — every cloud tool/service the repo uses. 6. **Local Development** — a step-by-step guide to run the repo locally. 7. **Projects** — one detailed section per project (monorepo) or a single project section (polyrepo). 8. **Important tasks** — the commands a developer runs day to day, from the repo's task runner (omit if the repo has none). When updating, **refresh these eight in place and keep every other section** an existing README has (License, Contributing, badges, …) — never delete them. ## 1. Detect (scan ...

Details

Author
virajp
Repository
virajp/ai-plugins
Created
2 months ago
Last Updated
yesterday
Language
JavaScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

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.

2 Updated 4 days ago
YosefHayim
Code & Development Listed

create-readme

Create a comprehensive, well-structured README.md for the current project. Use when the user wants to create, write, or refine a project's README.

1 Updated today
atman-33
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 5 days ago
Punpun1643