Escrevendo documentação

Use Markdown para textos comuns, listas, tabelas e código. Use componentes somente quando adicionarem semântica ou evitarem marcação complexa repetida.

Avisos e status

Callout aceita note, tip, warning ou danger. StatusBadge aceita stable, experimental, planned ou deprecated.

EstávelExperimentalPlanejadoDescontinuado

Card de repositório

Araru Server

Fundação estável

API central e estado persistente da aplicação.

GitHub

Etapas

Escolha o responsável

Altere o repositório que controla o comportamento.

Valide localmente

Execute os checks e o build de produção.

Diagrama

flowchart LR
Web --> Server
Android -. planejado .-> Server
Desktop -. planejado .-> Server
Server --> PostgreSQL
Server --> Redis

Limites dos serviços Araru

ArchitectureDiagram usa Mermaid, mantendo diagramas em evolução revisáveis. Faça diagramas pequenos, identifique conexões planejadas e forneça um título significativo.

Endpoint da API

GET/health

Retorna o estado de saúde do serviço.

Auth: Público

O componente resume o comportamento; o OpenAPI continua sendo o contrato autoritativo.

Comandos e árvores de arquivos

Validar toda a documentação

npm run check:all

Par de idiomas

src/content/docs/
├── docs/exemplo.md
└── pt-br/docs/exemplo.md

Mantenha comandos seguros para copiar e nunca inclua segredos reais ou caminhos pessoais. Árvores devem mostrar somente a estrutura necessária.