Cotani documentation
Esta é a fonte Markdown da Wiki do Cotani. Os READMEs dos módulos continuam sendo a referência mais próxima da instalação e das APIs específicas; esta página organiza os conceitos compartilhados e os guias de integração.
Guias principais
- Começando: instalação, dependências e pré-requisitos.
- Quickstart: um plugin mínimo com bootstrap e transição para a entity thread.
- Arquitetura: limites dos módulos, lifecycle e transições Paper/Folia.
- Arquitetura de pacotes: convenções para organizar classes e responsabilidades dentro de cada módulo.
- Contratos assíncronos: conclusão, timeout, cancelamento e shutdown.
- Índice de módulos: escolha do módulo adequado para cada caso de uso.
- Cookbook: padrões prontos para integração.
- Solução de problemas: falhas comuns e verificações rápidas.
- Prontidão para produção: staging, soak test, observabilidade, falhas e rollback.
- Guia de documentação: padrão para criar e manter páginas.
Generated API reference
O Javadoc agregado é gerado por ./gradlew aggregateJavadoc e publicado em /api/ pelo workflow do GitHub Pages. Ele
não é versionado no repositório.
Verification
Os exemplos que devem compilar ficam em docs-examples. Execute:
./gradlew check
Para exemplos que dependem de banco de dados, execute também as suítes com Docker:
./gradlew integrationTest
Para a validação completa antes de publicar uma versão:
./gradlew releaseVerification
Para visualizar a Wiki localmente:
cd website
npm ci
npm run start