Checklist de documentação de pacotes
Use ao adicionar ou alterar um pacote ou sua API pública.
- Propósito — Quando usar / quando não usar.
- Instalação — linha
npm i; observar peers (geralmente@agentskit/corevia pacotes de recurso). - Superfície pública — Exportações principais alinhadas a
src/index.ts(detalhes no TypeDoc). - Configuração — Tabelas de opções para as fábricas principais.
- Exemplos — Caminho feliz + um exemplo voltado a produção ou a um caso extremo.
- Integração — Links para pacotes adjacentes (mantenha a linha Ver também no fim de cada guia curta).
- Solução de problemas — FAQ breve (erros, variáveis de ambiente, divergência de versão).
Quando as exportações mudarem, atualize o guia e garanta que pnpm --filter @agentskit/docs build ainda passe (docs:api regenera o TypeDoc).