Skip to content

Docs Page Template

Use this structure for new docs pages to keep content consistent and scannable.

Purpose

Describe what this page covers and when to use it.

Public API / Interface

List the key functions, commands, or concepts with concrete signatures/examples.

Usage Example

Provide one minimal example and one realistic example.

Edge Cases and Errors

Call out common failure modes, validation behavior, and defaults.

Link to neighboring docs (upstream/downstream concepts).