note-001 should GuidesAPI docs Define a formal set of notice or callout types (Note, Caution, Warning) with explicit criteria for when each may and may not be used.
Notes and alerts
Callouts pull the reader’s eye away from the main flow, so each type has to mean something specific and be used only when that meaning applies. This page defines the notice types available and the criteria for using each one.
Match the callout type to the content
Section titled “Match the callout type to the content”Examples
- ✓ Note: You can also set this flag in a config file.
- ✗ Warning: You can also set this flag in a config file.
Rationale
Defined callout types with clear criteria keep authors consistent and keep the strongest alerts meaningful.