Doc title

One or two sentences: what this covers, for whom, and why it exists.

Audience: …Scope: …Status: stable

Overview

Replace with real content. Lead with the headline, then explain.

Note

Example callout — delete or repurpose.

Architecture

…

component A → component B → store

API reference

NameTypeDefaultDescription
limitint25Max items returned.

Examples

curl -H "Accept: application/json" https://api.example/v1/units
Tip

Small, runnable examples beat long prose.

Gotchas

Warning

…

Deprecated

… prefer the new API.

References

  • path/to/source.go — what it is, why it matters.
  • External doc