Conventions

This page explains patterns used throughout the AI Tells documentation.

Admonitions

The documentation uses colored boxes to highlight different types of information.

Notes highlight key information

Notes draw attention to important concepts or behaviors you should be aware of.

Tips suggest best practices

Tips provide performance advice or recommend preferred approaches.

Warnings flag potential issues

Warnings alert you to common pitfalls or behaviors that might be surprising.

Collapsible boxes contain optional details

Click to expand sections that provide additional context you can skip if you're in a hurry.

Documentation sections

Four sections organize the documentation based on your goals:

Tutorials

Step-by-step lessons for learning AI Tells from scratch.

Guides

Task-oriented recipes for accomplishing specific goals.

Explanation

Background information and conceptual discussions.

Reference

Technical specifications and reference documentation.