Documentation Conventions

This page defines the conventions we use throughout this documentation.

Whenever we include RIDDL source code in the documentation it will be in a fixed sized font like this:

domain MyDomain is { ??? }

Whenever an incidental note needs to be presented, it will be shown in blue like this paragraph.

Whenever an important recommendation needs to be made it will be shown in green like this paragraph.

Whenever a point that is often a source of confusion needs to be made, it will be shown in yellow like this paragraph.

Whenever a point that will lead to errors or have dangerous consequences needs be made, it will be shown in red like this paragraph.

Whenever an important RIDDL language definition is made, it will appear in a box like this.