Notes

To draw attention to auxiliary information that does not otherwise fit in the main text, use notices. Notices can include general notes, limitations, hints, important details and warnings.

You can use the following types of notices:

  • Note — provides supplementary details on issues that do not affect users directly.
  • Tip — provides helpful information that has a practical meaning but may not be obvious to users.
  • Important — provides essential details that could affect users in any way.

Use notices with caution; too many notices in one topic can make things messy and difficult to read. If you have several notices of the same type, try merging them together or adding some of them to the main text. 

NotesExample 1 (Note)

NotesExample 2 (Tip)

NotesExample 3 (Important)