# Reference Docs

Use this file for precise reference documentation about a specific Marin component, API, or workflow.

## Assume This Reader

- Assume the reader already knows Marin at a practical level.
- Assume the reader may not know this specific component, API, or behavior yet.
- Do not assume they need onboarding to the broader project.

## Optimize For

- Help an experienced Marin user answer specific usage and behavior questions quickly.
- Make constraints, inputs, outputs, defaults, and edge cases easy to find.

## Write This Way

- Be precise and complete.
- Do not hand-hold.
- Document inputs, outputs, behavior, and constraints directly.
- Prefer explicit behavior over narrative explanation.
- Explain Marin-specific context only when it is required to use or interpret the documented thing.
- Cite the relevant source artifacts for behavior, design intent, or background when they materially help readers, such as related issues, PRs, reports, or papers.
- For longer reference docs, add section-level summary lines when they improve scanability.
- For longer reference docs, include a short doc-level TL;DR or overview near the top.

## Test

- Ask whether a reader who knows Marin, but not this exact area, could use the doc as a reliable reference.
