---
title: "Documentation Conventions"
description: "Documentation Conventions: Features in simplyblock are released when reaching general availability."
source: "https://docs.simplyblock.io/latest/important-notes/documentation-conventions/"
---

# Documentation Conventions

## Feature Stages

Features in simplyblock are released when reaching general availability. However, sometimes, features are made available
earlier to receive feedback from testers. Those features must be explicitly enabled and are marked in the
documentation accordingly. Features without a specific label are considered ready for production.

The documentation uses the following feature stage labels:

- **General Availability:** This is the default stage if nothing else is defined for the feature. In this stage, the
  feature is **considered ready for production**.
- **Technical Preview:** The feature is provided for testing and feedback acquisition. It is not regarded as stable
  or complete. Breaking changes may occur, which could break backward compatibility. Features
  in this stage are **not considered ready for production**. Features in this stage need to
  be specifically enabled before use.

## Admonitions (Call-Outs)

### Notes

Notes include additional information that may be interesting but not crucial.

!!! note
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

### Recommendations

Recommendations include best practices and recommendations.

!!! recommendation
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

### Infos

Information boxes include background and links to additional information.

!!! info
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

### Warnings

Warnings contain crucial information that should be considered before proceeding.

!!! warning
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.

### Dangers

Dangers contain crucial information that can lead to harmful consequences, such as data
loss and irreversible damage.

!!! danger
    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
    massa, nec semper lorem quam in massa.