Cómo actualizar esta documentación
Correr el sitio en local
Sección titulada «Correr el sitio en local»cd appnpm installnpm run dev # http://localhost:4321npm run build # genera el sitio estático en dist/Dónde vive cada cosa
Sección titulada «Dónde vive cada cosa»| Contenido | Archivo | Cómo se edita |
|---|---|---|
| Guías de API (headers, errores, auth, etc.) | app/src/content/docs/guias/*.md |
Markdown a mano |
| Estado del proyecto/backend/frontend/golden paths | app/src/content/docs/{proyecto,backend,frontend,golden-paths}/*.md |
No se edita aquí — se sincroniza desde el docs//README.md real de cada repo con ./scripts/sync-wiki.sh |
| Introducción general | app/src/content/docs/introduccion.md |
Markdown a mano |
| Referencia de endpoints | Generada por starlight-openapi desde app/openapi/openapi.json |
No se edita aquí — se edita el spec |
| Navegación / sidebar | app/astro.config.mjs |
Añadir el slug de páginas nuevas |
| Infra / deploy | infra/, envs/, Makefile, .github/workflows/ |
Terraform (Cloudflare Pages + dominio) — ver README |
El OpenAPI es la fuente de verdad
Sección titulada «El OpenAPI es la fuente de verdad»El spec canónico vive en lade-infra/docs/reference/openapi.json. Este repo guarda una copia en app/openapi/openapi.json. Para sincronizar después de cambiar el spec en lade-infra:
cd app && npm run sync-spec(asume lade-infra como hermano de este repo en el mismo directorio padre — no app/).
El resto de la wiki (backend, frontend, golden paths) también se sincroniza, no se edita directo
Sección titulada «El resto de la wiki (backend, frontend, golden paths) también se sincroniza, no se edita directo»Las secciones Proyecto, Backend y Frontend son copias con frontmatter de los docs/ESTADO_ACTUAL.md/PROXIMOS_PASOS.md reales de cada repo (fuente de verdad técnica); Golden Paths copia los README.md de lade-templates, lade-factory y lade-admin-panel. Para actualizar después de un cambio en cualquiera de esos archivos fuente:
./scripts/sync-wiki.sh # desde la raíz de este repo, con los otros repos clonados como hermanosNo hay trigger automático todavía — si alguien edita lade-infra/docs/ESTADO_ACTUAL.md y no se vuelve a correr sync-wiki.sh (+ redeploy), esta wiki queda desactualizada hasta que alguien lo note y lo corra.
Regla de oro
Sección titulada «Regla de oro»Endpoint nuevo o modificado en lade-infra ⇒ actualizar openapi.json en el mismo PR ⇒ npm run sync-spec aquí ⇒ commit. Cambio real en el estado de un repo ⇒ ./scripts/sync-wiki.sh ⇒ commit. Si el cambio toca auth, headers o formato de errores, actualizar también la guía correspondiente.
Pendientes conocidos
Sección titulada «Pendientes conocidos»- Automatizar el sync (OpenAPI y wiki) con un GitHub Action (PR automático cuando cambie la fuente en el repo correspondiente).
- Hosting en
internal.docs.lade.com.mxdetrás de Cloudflare Access (historia en el backlog de Notion).