blockmatic/basilic-skills

w-api-docs

Refresh API docs from the owning schema source; never edit generated OpenAPI by hand.

Ver código-fonte

Como usar

  1. Copie o comando e verifique o pacote antes de instalar no seu ambiente de agente.
  2. Consulte no original as ferramentas, credenciais e ambientes necessários.
  3. Descreva os dados de entrada e a entrega esperada; confira a saída com as fontes.
npx skills add https://github.com/blockmatic/basilic-skills --skill w-api-docs

Antes de começar

  • A instalação não inclui assinatura de modelo, franquia API ou acesso aos seus arquivos.
  • Estrelas e instalações indicam atividade, não um teste independente de qualidade ou segurança.
Documento original do Skill

Renderizado do repositório de origem, preservando títulos, exemplos, código, tabelas, links e imagens.

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.

Relacionados por tarefa

do mesmo repositório

Mais Skills

Todos os Skills