generate-docs

Generate and refresh repo-root README, LICENSE, CODE_OF_CONDUCT, and CONTRIBUTING files.

1|Updated Sep 13, 2026
One-click install
npx skills add https://github.com/silentFellow/public-dotfiles --skill generate-docs-silentfellow
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-docs
Source: https://github.com/silentFellow/public-dotfiles/tree/main/agents/skills/generate-docs
Command: npx skills add https://github.com/silentFellow/public-dotfiles --skill generate-docs-silentfellow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Repositories often ship with missing, stale, or inconsistent root documentation, and drafting READMEs or license text from scratch leads to invented details and mismatched tone. This Skill detects the repo's tone and file needs, confirms them with the user in one batched question, and writes or patches documentation grounded in the actual code. ## Core Features & Use Cases - Tone and disposition detection: Classifies the repo as professional, community, personal, or friendly, and recommends which root files (README, LICENSE, CONTRIBUTING, CODE_OF_CONDUCT) apply, confirmed via a single batched question. - Gap-based README refresh: Treats existing docs as a checklist, patching stale facts like new env vars or dead links without restructuring content the user didn't ask to change. - Verbatim license copying: Copies canonical license texts (MIT, Apache-2.0, BSD-3-Clause, ISC, Unlicense) from bundled templates, filling only year and holder placeholders instead of generating legal text from memory. - Use Case: Before publishing a side project to GitHub, run this Skill to get a right-sized README, an MIT LICENSE with the correct copyright holder, and a clear recommendation on whether CONTRIBUTING or CODE_OF_CONDUCT files are warranted. ## Quick Start Use the generate-docs skill to create or refresh the README and other root documentation for this repository before publishing it.

Frequently Asked Questions about generate-docs

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

FAQPage Schema
How do I generate a README for my GitHub repository?▼

Run the Skill against your repo and it detects the tone (professional, community, personal, or friendly) from existing signals, then writes a README matched to that tone. Professional and community repos get full structure with badges and table of contents; personal repos get a lighter form.

How do I add a LICENSE file to my repo?▼

The Skill asks which license and copyright holder to use, then copies the canonical text verbatim from bundled templates (MIT, Apache-2.0, BSD-3-Clause, ISC, Unlicense), filling only the year and holder placeholders. It never drafts license text from memory.

When should a repo include CONTRIBUTING and CODE_OF_CONDUCT files?▼

Create them when a public repo accepts or wants external contributors. Skip them for private repos, and skip CONTRIBUTING if an existing AGENTS.md or equivalent already documents contribution conventions.

Can I refresh an existing README without rewriting it?▼

Yes. The Skill treats an existing README as a gap checklist, patching only missing or stale facts like new environment variables, scripts, or dead links. It does not restructure sections or rewrite prose unless the structure genuinely contradicts the code.

Why should license text be copied instead of generated?▼

License text is legal boilerplate where small wording differences matter. Generating it fresh produces subtly inconsistent licenses across projects, so the Skill copies the same canonical source every time or fetches official text from spdx.org for licenses outside its bundled set.