Contribuindo com a documentação

Regra de ownership

Documentação de um componente fica junto do seu código. Conteúdo que atravessa vários serviços fica em 2finance-docs/content/docs.

Adicionar um serviço

1. Crie um diretório docs/ no repositório dono.
2. Escreva um index.mdx com frontmatter title e description.
3. Adicione o repositório a config/repositories.mjs.
4. Conecte a coleção em lib/source.ts com um baseDir estável.
5. Execute npm run sync:docs e npm run check.

O diretório workspaces/<id>/repository é checkout ou symlink de build. Não copie MDX permanentemente para content/docs.

OpenAPI

Registre o caminho do schema no registry e carregue-o pelo servidor do fumadocs-openapi. A referência deve ser derivada do contrato, não reescrita à mão.

Qualidade mínima

• confirme o comportamento em API, código, configuração e testes;
• não publique credentials, tokens ou endpoints sensíveis;
• prefira poucas páginas substantivas a páginas vazias;
• marque informação não verificável como Needs verification;
• mantenha URLs orientadas ao produto, não ao nome físico do repositório.