Notas
En nuestra documentación podemos incluir tres tipos de notas:
- Nota simple: Sirve para sumar un tip o recomendación que se quiera destacar en un nivel levemente superior a la documentación.
markdown
> Esto es un ejemplo de nota.
- Nota de aclaración: Sirve para brindar aclaraciones sobre algún paso del proceso que estamos documentando. Pueden incluirse para redirigir al lector a algún otro paso o documentación, brindar una vía de contacto para resolución de problemas, mencionar alternativas que puedan ser útiles en esa parte del proceso, entre otros.
markdown
> NOTE
>
> Título
>
> Cuerpo de la nota.
- Nota de prevención: Sirve para llamar la atención del lector en algún paso del proceso. Puede incluirse para señalar la necesidad de cumplir con algún paso previo, mencionar limitaciones que pudieran surgir, indicar un deprecado de versiones/medio de pago, entre otros.
markdown
> WARNING
>
> Título
>
> Cuerpo de la nota.