Coding Conventions

Follow these conventions so pages stay consistent across the site.

Page structure

Every page needs frontmatter and a single top-level heading.

Frontmatter

Give every page a title and a description in the frontmatter.

---
title: Page Title
description: One sentence describing the page.
---

# Page Title

Headings

Use one # heading per page. Use ## for sections and ### for subsections. The right sidebar builds its outline from these headings, so keep them descriptive.

Formatting elements

The table below lists the Markdown elements used across example pages in this site.

Element	Syntax	Purpose
Table	| a | b |	Compare structured values
Code block	```lang	Show exact commands or config
Container	::: tip / ::: warning	Call out important notes

TIP

Prefer a table over a bulleted list when you are comparing more than one attribute per item.

WARNING

Do not put secrets, tokens, or passwords in any Markdown page — this repository is version-controlled and readable by every account with docs access.

Linking between pages

Link with a root-relative path and the .md extension, for example Getting Started. See the image handling notes for how to reference images.