Writing documentation

Use Markdown for ordinary prose, lists, tables, and code. Use components only when they add semantics or prevent repeated complex markup.

Callout and status

Callout accepts note, tip, warning, or danger. StatusBadge accepts stable, experimental, planned, or deprecated.

StableExperimentalPlannedDeprecated

Repository card

Araru Server

Stable foundation

Core API and durable application state.

GitHub

Steps

Choose the owner

Change the repository that owns the behavior.

Validate locally

Run checks and the production build.

Diagram

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

Araru service boundary

ArchitectureDiagram uses Mermaid source, keeping evolving diagrams reviewable. Keep diagrams small, label planned edges, and provide a meaningful title.

API endpoint

GET/health

Returns the service health state.

Auth: Public

Endpoint components summarize behavior; OpenAPI remains the authoritative contract.

Commands and file trees

Validate all documentation

npm run check:all

Locale pair

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

Keep command values copy-safe and never include real secrets or personal paths. File trees should show only the structure needed to explain the task.