Admonitions and Message Style

Admonitions should improve readability, not add visual noise.

Recommended usage

• Note: operational clarifications readers should not miss.

• Warning: behavior risks, compatibility caveats, or misuse hazards.

• Tip/dropdown: optional deep dives or advanced alternatives.

Writing rules

• Keep admonitions concise and specific.

• Prefer actionable wording over abstract commentary.

• Do not duplicate the same warning across multiple pages unless required.

Consistency

Admonition language should match the project’s diagnostic style: explicit, concrete, and reproducible.