Contribuir a la documentación

Esta documentación se construye con MkDocs y el tema Material for MkDocs. El contenido se escribe en Markdown dentro de la carpeta docs/.

Entorno local

Requisitos: Python 3.10+ y git.

# 1. Crear el entorno virtual (solo la primera vez)
python3 -m venv .venv

# 2. Instalar dependencias
.venv/bin/python -m pip install -r requirements.txt

# 3. Levantar el servidor de desarrollo con recarga en vivo
.venv/bin/mkdocs serve

Abre http://127.0.0.1:8000 en tu navegador. Los cambios en docs/ se recargan automáticamente.

Flujo de trabajo

1. Crea una rama a partir de main.
2. Edita o crea archivos .md en docs/.
3. Si agregas una página nueva, añádela a la sección nav de mkdocs.yml.
4. Verifica localmente con mkdocs serve.
5. Abre un Pull Request para revisión.

Convenciones de estilo

• Un archivo por tema; nombres en minúsculas con guiones (mi-tema.md).
• Un solo encabezado # (H1) por página.
• Usa admoniciones (!!! note, !!! warning, !!! tip) para resaltar información.
• Diagramas con Mermaid usando bloques mermaid.
• Escribe en español, en tono claro y directo.

Estructura del repositorio

legalys-docs/
├── docs/                 # Todo el contenido en Markdown
│   ├── index.md          # Página de inicio
│   ├── primeros-pasos/
│   ├── arquitectura/
│   ├── guias/
│   ├── referencia/
│   └── operaciones/
├── mkdocs.yml            # Configuración del sitio y navegación
├── requirements.txt      # Dependencias de Python
└── .gitignore

Construir el sitio estático

.venv/bin/mkdocs build   # genera la carpeta site/ (ignorada por git)