Mantener esta documentación

Este sitio está hecho con Fumadocs, un framework de documentación sobre Next.js. Vive en su propio repositorio privado, deltamontero/lms-docs, separado del código de la plataforma (deltamontero/lms-moodle). Se genera como sitio estático: el resultado es una carpeta de archivos HTML que se puede publicar en cualquier servidor web.

Cómo se conectan los dos repositoriosCopy Anchor Link

El repositorio de la documentación incluye al de la plataforma como submódulo de Git, en la carpeta moodle/. Así:

• Quien documenta tiene el código a mano, en moodle/, sin salir de este repositorio.
• Cada versión de la documentación registra a qué versión exacta del código corresponde: el submódulo apunta a un commit de lms-moodle.
• La conexión va en un solo sentido. lms-moodle no sabe nada de este repositorio, así que el despliegue de Moodle en Coolify no depende de la documentación.

EstructuraCopy Anchor Link

• Cada página es un archivo .mdx (Markdown con componentes) dentro de content/docs/. Por ejemplo, operacion/respaldos.mdx se publica en /docs/operacion/respaldos.
• El orden del menú de cada carpeta está en su meta.json ("pages": [...]).
• El nombre del sitio y el repositorio están en lib/shared.ts; la portada, en app/(home)/page.tsx; los textos de la interfaz en español, en components/provider.tsx.
• moodle/ es el submódulo con el código de la plataforma.

Descargar el repositorioCopy Anchor Link

La primera vez, con el submódulo incluido:

git clone --recurse-submodules https://github.com/deltamontero/lms-docs.git

Si ya lo descargó sin el submódulo:

git submodule update --init

Documentar un cambio de la plataformaCopy Anchor Link

git submodule update --remote moodle

git diff --submodule=log moodle

git add content moodle
git commit -m "Document <cambio>"
git push

Ver el sitio en su equipoCopy Anchor Link

Necesita Node.js 22 o superior.

npm install
npm run dev

Se abre en http://localhost:3000. Los cambios en los .mdx se ven al guardar.

Generar el sitio para publicarloCopy Anchor Link

npm run build

El sitio queda en la carpeta out/, que se publica en cualquier servidor web estático. Para revisarlo antes de publicarlo, ejecute npm run start.

Escribir una páginaCopy Anchor Link

Cada página empieza con su título y su descripción:

---
title: Título de la página
description: Una línea que resume la página.
---

## Primera sección

Componentes disponibles sin importar nada: Callout, Cards/Card, Steps/Step, Tabs/Tab, Accordions/Accordion y Files/Folder/File.

Reglas de esta documentación:

• Sin secretos: contraseñas, claves y tokens van en las variables de entorno de Coolify y en el gestor de contraseñas, nunca aquí.
• Sin datos personales: a las personas se las nombra por su cargo o rol.
• Marca: siempre "Deltamontero".
• Fuente única: la documentación describe lo que hace el código. Si cambia el código, se actualiza la página.