ADR 0081 — Documentación y Desarrollo, dos zonas
This content is not available in your language yet.
Development
Estado: aceptado · Fecha: 2026-10-26 · Enmienda: ADR 0080
Contexto
Sección titulada «Contexto»ADR 0080 separó los documentos en dos bloques de la misma sidebar, pero todo seguía bajo /docs/:
quien llegaba a instalar CodArch veía en el lateral los ochenta ADR, la búsqueda mezclaba el uso
con el diseño interno, «Siguiente» saltaba del FAQ al roadmap y la guía vivía aparte en /guia/.
Las páginas de uso, además, enlazaban ADR en mitad de las instrucciones y casi no tenían capturas.
Decisión
Sección titulada «Decisión»- Dos zonas con su URL. Documentación (
/docs/) es solo el producto: la portada dedocs/index.mdydocs/usar/**. Desarrollo (/desarrollo/) es el roadmap, el modelo de datos, el diseño del mapa, la migración a Rust, los ADR y la guía en/desarrollo/guia/. Los ficheros viven enapps/site/docs/usar/yapps/site/docs/desarrollo/(y sus gemelas endocs/en/). La traducción de fichero a URL está en un único sitio,src/lib/zonas.mjs. - El
sectiones la zona. El enum pasa ausar | desarrollo(dejaproducto | construir | adr); los ADR se reconocen por su carpetadesarrollo/adr/. - Una sidebar por zona.
sidebarUsar()ysidebarDesarrollo()ensidebar.mjs; el componenteSidebarde Starlight se sustituye por uno que pinta solo la zona de la página, y «Anterior/Siguiente» no cruzan de zona. - Cabecera: Inicio · Documentación · Desarrollo. La guía está dentro de Desarrollo. La portada
y el pie llevan a «Empezar» (instalación) y «Cómo se construye» (
/desarrollo/). - Búsqueda por zona. Cada documento lleva el filtro de Pagefind
zona, con el nombre de la zona en el idioma de la página (Documentación/Desarrollo, Documentation/Development). La búsqueda se abre con el filtro de la zona actual ya puesto, así que buscar «ADR» desde/docs/no devuelve solo ADR; el panel de filtros de Pagefind permite quitarlo y ver la otra zona. - Las direcciones antiguas redirigen.
/docs/adr/*,/docs/model,/docs/migration,/docs/design/map,/docs/rules,/docs/mcp,/docs/usar/cli/mcpy/guia/*, también en/en/. Las dos páginas de MCP se unen endocs/usar/mcp.mdyrules.mdpasa adocs/usar/reglas.md. - Las páginas de uso no enlazan ADR salvo en una nota final «Para saber más». Cada página de
interfaz (webapp, escritorio, primeros pasos) lleva al menos una captura en
docs/images/, con los nombres que enseña la interfaz.
Consecuencias
Sección titulada «Consecuencias»- Una página de uso nueva va en
docs/usar/consection: usar; una de diseño, endocs/desarrollo/consection: desarrollo. Las dos con su gemela endocs/en/. - Los enlaces del markdown siguen siendo relativos entre ficheros; el plugin de enlaces y
rutas.tscalculan la zona. - Los tests fijan las dos sidebars, las rutas de cada zona y las redirecciones.
Alternativas descartadas
Sección titulada «Alternativas descartadas»- Dos sitios Starlight. Duplica configuración, búsqueda e idiomas para separar dos listas.
- Dejar todo en
/docs/y ocultar los ADR en la sidebar. La búsqueda y la paginación seguían mezclando las zonas y las URL no decían qué es cada cosa. - Mantener
/guia/en la raíz. La guía es parte de cómo se construye y la cabecera tendría cuatro entradas.
Hoja de ruta
Sección titulada «Hoja de ruta»Documentos — Dos zonas
Sección titulada «Documentos — Dos zonas»- Ficheros en
docs/usar/ydocs/desarrollo/, enumusar | desarrolloy redirecciones. - Sidebar por zona, cabecera, portada, pie y filtro de búsqueda.
- Webapp, escritorio y primeros pasos con capturas por pantalla; MCP en una sola página.
El registro de lo hecho vive en el feed de la guía.