mcpField
W
w-api-docs

w-api-docs

github.com/blockmatic-iceboxDevelopment1647 installsUpdated 4w ago
Repository

About w-api-docs

w-api-docs is a Basilic workflow skill for maintaining API documentation from its source of truth. It directs changes to owning schemas or routes, uses documented generators, and avoids editing generated artifacts directly.

Key features

  1. 01Finds the owning API source and generator
  2. 02Changes schemas or routes, not generated output
  3. 03Runs the documented generation command
  4. 04Updates adopter docs when behavior changes

Use cases

  1. 01Refreshing API documentation from source
  2. 02Generating OpenAPI or client artifacts
  3. 03Documenting changed API behavior

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/blockmatic-icebox/basilic-skills --skill w-api-docs

After installing, type/w-api-docsin Claude Code to confirm it loaded.

Details

From the project README

Update API documentation from the source of truth (TypeBox/Fastify routes, or the repo's documented generator). Never edit generated OpenAPI, generated clients, or generated SQL directly.

  1. Read the API docs MDX and the generator README. Identify the owning source and the generate script in package.json.
  2. Change the owning schema or route, not the generated artifact.
  3. Run the documented generate command. Check drift scripts if the repo has them.
  4. Update adopter MDX only for behavior that changed. Do not invent auth, rate-limit, or versioning policy.
  5. Docs: /w-docs if behavior or commands changed.

Comments

Markdown supported