agentleFS
Sign inStart free
buildpad-aibuildpad-ai/skills/generate-docs/SKILL.md

generate-docs

Skill1 starsChanged 27 days agoMITView on GitHub

Generate or update documentation for DaaS application code changes including API references, component docs, hook docs, schema files, and changelogs. Use when the user says generate-docs, update docs, document this, or needs documentation.

17 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use commit and code-review.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • SentrySkill

    commit

    Create commit messages following Sentry conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits with Sentry-specific issue references.

    Also in 3 projects that use this

  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 16 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every code change MUST have corresponding documentation updates.

    line 9

“Common” is measured: kept by at least 6 in 10 of the 16 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Generate Documentation

Every code change MUST have corresponding documentation updates.

Documentation by Change Type

What ChangedDocumentation Required
API endpointdocs/API_REFERENCE.md, docs/api/[collection].md
Componentdocs/COMPONENTS.md, docs/components/[name].md
Hookdocs/HOOKS.md
Collectiondocs/COLLECTIONS.md, docs/schemas/[name].schema.json
Featuredocs/features/[name].md
Workflowdocs/WORKFLOWS.md
Any changedocs/CHANGELOG.md (always!)

Process

  1. Read the code that was changed or created
  2. Identify doc type from the table above
  3. Generate docs following the templates below
  4. Update CHANGELOG.md with a dated entry

API Route Documentation Template

## [Method] /api/[endpoint]

**Description:** Brief description

**Authentication:** Required / Public

**Request Body:**
| Field | Type | Required | Description |
|-------|------|----------|-------------|

**Response:**
| Status | Body | Description |
|--------|------|-------------|

**Example:**

Component Documentation Template

## ComponentName

**Import:** `import { ComponentName } from '@/components/ui/component-name'`

**Props:**
| Prop | Type | Default | Description |
|------|------|---------|-------------|

**Usage:**
[Working code example]

Standards

  • JSDoc comments on all exported functions/types
  • Usage examples for every public API
  • Complete prop tables for components
  • Working code examples that can be copy-pasted

References

  • Documentation guidelines

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free