Cómo usar este repo¶

La documentación vive en Markdown dentro de docs/. MkDocs arma el sitio; Coolify lo publica.

Flujo de trabajo¶

Creá o editá un .md en docs/.
Si es una página nueva, sumala a nav en mkdocs.yml y a la tabla del index.md de la sección, en el mismo PR.
Probá en local con mkdocs serve (idealmente mkdocs build --strict).
Commit + push a main.
Coolify construye la imagen y publica.

Dónde poner cada cosa¶

Tipo	Carpeta	Ejemplo
Cómo se hace un trabajo	`docs/procesos/`	Alta de un cliente, cierre de mes
Qué hacer ante un incidente	`docs/runbooks/`	n8n caído, certificado vencido
Dónde corre, DNS, puertos	`docs/infraestructura/`	VPS, Coolify, dominios
Cómo escribir y publicar docs	`docs/guia/`	Esta página
Plantillas para copiar	`docs/guia/plantillas/`	Proceso, runbook
Coolify, GitHub App, deploys	`docs/coolify/`	Qué es Coolify

Crear una página¶

cp docs/guia/plantillas/proceso.md docs/procesos/mi-proceso.md
# o
cp docs/guia/plantillas/runbook.md docs/runbooks/mi-incidente.md

Editá el archivo y agregalo en mkdocs.yml:

nav:
  - Procesos:
      - Índice: procesos/index.md
      - Mi proceso: procesos/mi-proceso.md

También actualizá la tabla en docs/procesos/index.md (o runbooks/) en el mismo PR.

Sin entrada en nav no aparece en el menú

MkDocs igual puede construirla, pero nadie la encuentra. Siempre registrala en nav. El nav es la fuente de verdad del menú; los índices se mantienen al día en el mismo cambio.

Más detalle: Convenciones y plantillas.

Vista previa local¶

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

http://127.0.0.1:8000

--strict en el Dockerfile corta el deploy si hay un link roto. Si el build de Coolify falla, mirá el log: casi siempre es un enlace a una página que todavía no existe o un ítem de nav apuntando mal.

Markdown útil¶

Material entiende admonitions, tabs, checklists y diagramas:

!!! note "Nota"
    Texto destacado.

!!! warning "Cuidado"
    Riesgo operativo.

=== "Producción"
    Comando de prod.

=== "Local"
    Comando de local.

- [x] Paso hecho
- [ ] Paso pendiente

\`\`\`mermaid
flowchart LR
  A --> B
\`\`\`

Más detalle en Convenciones.