Conventions
- Use the shared MDX components:
AppliesTo — add applicability at the top of every page.AtAGlance — start pages with 3–5 bullets of key facts.FlowNav — add quick navigation to related flows, API, or index pages.VersionMatrix — show v2 vs v3 differences concisely.
- Keep imports at the top of
.mdx files (MDX v2 requirement).
- Favor H2/H3 sections with short names to ensure a useful right‑hand TOC.
- Link to API operations using operationIds (e.g.,
/api#operation/submitReportV3).
- Add a "Code references" section with file paths relevant to the content.
- Avoid inline styles when possible; prefer shared components and
custom.css.
Style
- Write in present tense; be concise and direct.
- Use tables sparingly;
VersionMatrix is preferred for v2/v3 comparisons.
- Prefer lists that can be quickly scanned.