docsmith

v0.9.1

Keeps READMEs, API references, and changelogs in sync with the code they describe. Regenerates only the sections that drifted.

3 skills

by Foundry LabsApache-2.02.3kupdated 4 months ago

Install

$ git clone https://github.com/foundrylabs/docsmith

Clone into your agent client’s plugin directory — components are discovered from fixed locations per the spec.

Layout

docsmith/

├── plugin.json
└── skills/
    ├── api-reference/
    │   └── SKILL.md
    ├── changelog/
    │   └── SKILL.md
    └── readme-refresh/
        └── SKILL.md

Skills3

api-referenceskills/api-reference/

Regenerate API reference sections from exported symbols, preserving hand-written prose between markers.

changelogskills/changelog/

Draft a changelog entry from merged commits since the last tag, grouped by change type.

readme-refreshskills/readme-refresh/

Detect drift between the README and the current CLI flags, config options, and examples, then patch it.

Manifest

plugin.json

{
  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
  "name": "docsmith",
  "version": "0.9.1",
  "description": "Keeps READMEs, API references, and changelogs in sync with the code they describe. Regenerates only the sections that drifted.",
  "author": {
    "name": "Foundry Labs",
    "url": "https://foundrylabs.dev"
  },
  "homepage": "https://foundrylabs.dev/docsmith",
  "repository": "https://github.com/foundrylabs/docsmith",
  "license": "Apache-2.0",
  "keywords": [
    "documentation",
    "readme",
    "changelog"
  ]
}