Reportar um problema

Editar páginaReportar problema

Caso você encontre algum problema na documentação, como um erro de digitação, uma informação incorreta ou algo que não esteja claro, você pode editar as páginas diretamente no GitHub.

Como editar uma página

Todas as páginas da documentação possuem um botão de "Editar página". Ao clicar nesse botão, você será redirecionado para a página correspondente no repositório do GitHub.

Todas as páginas são feitas em MDX. Mas atenção, as páginas de referência das APIs são geradas automaticamente a partir do código, então não faça alterações nelas. Você pode editar no GitHub apenas as páginas que não são geradas automaticamente, como esta.

As páginas de referência das APIs são geradas a partir do código, com base na especificação OpenAPI 3.0. Todas as APIs exportam sua documentação em formato OpenAPI 3.0 pelo endpoint /doc.

Reportar um problema

Se você encontrou um problema, como um erro de digitação, uma informação incorreta ou algo que não esteja claro, você pode reportar o problema diretamente no GitHub.

Assim como o botão de "Editar página", você pode clicar no botão "Reportar um problema" que está na parte superior direita da página, ao lado do "Editar página". Isso abrirá uma nova página no GitHub, onde você pode descrever o problema que encontrou em uma issue.

Mas se possível, trate de fazer um Pull Request com a correção do problema. Isso ajuda a manter a documentação sempre atualizada e com informações corretas.