Callout Boxes
Callout boxes are a powerful way to highlight important information in your documentation, helping to draw attention to specific messages or alerts. EasyPageGO offers five different variants of callout boxes: Note, Info, Success, Warning, and Error. Each variant serves a distinct purpose and can enhance the clarity of your content.
The body of the callout boxes is formatable, allowing you to use all the text formatting features listed in the Text Formatting page.
By using these callout boxes appropriately, you can effectively guide your users through your documentation, ensuring they understand critical information and potential pitfalls.
Variants of Callout Boxes
There are five different variants. There are 5 variations available. It is possible to change the variant of a callout box through its menu.
Note
Use the Note variant to provide additional context or supplementary information that enhances understanding but is not critical to the main content.
Example: This feature is currently in beta and may be subject to change.
Info
The Info box is ideal for conveying general information that your users should be aware of during their experience.
Example: Our documentation is regularly updated to reflect the latest changes.
Success
Highlight successful actions or positive outcomes with the Success variant. This is perfect for acknowledging user achievements or signaling completion.
Example: Hooray! You successfully completed our SDK setup!
Warning
The Warning box is used to alert users to potential issues or important considerations that could impact their progress.
Example: Ensure that you back up your data before proceeding with the update.
Error
When immediate attention is needed due to a critical issue, use the Error variant to communicate errors or problems effectively.
Example: If you don't see the expected output, you may have to start over.