Docs
Cualquier miembro de Omnia puede escribir docs
Estructura de la Documentación
Toda nuestra documentación se encuentra en la carpeta src. A continuación, te explicamos cómo debes organizar los archivos y carpetas para facilitar su lectura y acceso.
1. Estructura de Carpetas
Cada sección debe tener su propia carpeta, siguiendo este formato de nombre:
número-nombre(por ejemplo:1-backend,2-new-client).
Puntos importantes:
- Número inicial: El número al principio de la carpeta es para ordenar las secciones de manera lógica.
- Formato de nombre: Usa kebab-case (todo en minúsculas y con guiones entre las palabras). Ejemplo:
1-backend,2-new-client. - Cada carpeta debe tener un archivo
index.mdque sirva como la página principal de esa sección. - Navbar: El título del navbar se extraerá directamente del título principal del archivo
index.mddentro de cada carpeta.
2. Archivos de Documentación
Dentro de cada carpeta, los archivos deben seguir este formato de nombre:
número-nombre(por ejemplo:1-installation.md,2-setup-backend.md).
Reglas clave para los archivos:
- Título Principal: Cada archivo debe comenzar con un título principal (
# Título principal), que es lo que aparecerá en lasidebarde la documentación. - Subtítulos: Si un archivo tiene subtítulos, estos también aparecerán en el menú lateral, pero solo hasta el tercer nivel (por ejemplo:
### Subtítulo de tercer nivel).
Recursos Útiles
Para ayudarte a escribir documentación clara y bien estructurada en formato Markdown, te recomendamos este recurso:
- Markdown Cheat Sheet (markdownguide.org) – Una referencia rápida con los elementos más comunes de Markdown.