Pular para o conteúdo
Começar um projetoComeçar

Docs da API

Docs para as pessoas e os agentes que usam a sua API. Guias e a referência da API em /docs no seu domínio, em cada idioma do projeto.

O que ele adiciona

  • apps/docs, gerado pelo Blume: guias em MDX e a referência da API, gerada a partir do documento OpenAPI das suas operações. Uma nova operação aparece na referência com a própria descrição.
  • As docs em /docs no seu domínio principal: o app faz o rewrite de /docs para o deploy das docs.
  • Um llms.txt próprio e uma cópia em Markdown de cada página, para os agentes.
  • Guias em cada idioma do projeto. pnpm --filter docs translate escreve as traduções que faltam com o Claude.

Como configurar

O pnpm dev também inicia as docs em http://localhost:4321/docs, e o app serve as docs em http://localhost:3000/docs.

Para fazer o deploy, crie um segundo projeto na Vercel com o Root Directory apps/docs e o SITE_URL definido com a URL de produção do app. Depois defina DOCS_ORIGIN no app com a URL do projeto das docs.

Antes de entrar no ar

O deploy do projeto das docs está feito, e o /docs do domínio principal mostra as docs.

Deixar de fora ou adicionar depois

Deixe docs fora de --modules para começar com um único app. Para adicionar as docs a um projeto existente, peça ao seu agente para usar o skill add-module.

Rode um comando. A CLI pergunta o resto, e o seu agente continua daí.

pnpm create turbinekit my-app
Ver o prompt

Cole em um agente que possa rodar comandos, como Claude Code, Codex ou Cursor. O prompt está em inglês.

Create a new TurbineKit project with me.
Talk to me in Brazilian Portuguese.

TurbineKit (https://turbinekit.dev) is an open-source Turborepo and Next.js starter. Its CLI, create-turbinekit, needs Node.js 24 and pnpm 10 (run `corepack enable` once).

1. Run `pnpm dlx create-turbinekit --help` to see its options.
2. Ask me its questions one at a time, with their defaults: the folder, the product name, one sentence about the product, the company or legal name, the contact email, the languages and the modules. Skip what I have already told you.
3. The CLI only asks questions in an interactive terminal, so run it with my answers as options and `--yes`. Show me the command before you run it.
4. In the new folder, read AGENTS.md. Then do "1. Minimal setup" in SETUP.md, and tick each box you finish.
5. Tell me the URL of the running app, and which services SETUP.md lists next.

Sem cadastro, sem chaves de API. Precisa de Node.js 24 e pnpm 10.