esofitec. CoreDocs

esofitec. CoreDocs

Visión general

Arquitectura y funcionamiento

El flujo completo de CoreDocs es lineal y fácil de automatizar:

  1. CoreDocs.Tech aporta carpetas de categoría, Markdown y assets.
  2. CoreDocs.Engine lee config.json, localiza content_root y descubre las categorías.
  3. Cada category.json define la identidad de una web.
  4. Cada .md aporta su front matter y su contenido.
  5. El motor renderiza HTML, navegación, breadcrumbs, búsqueda y home global.
  6. La salida se escribe en output_root.

Piezas principales#

1. Metadata de categoría#

Cada carpeta de producto debe tener un category.json con solo la definición de la categoría:

{
  "title": "S360 Proyectos",
  "slug": "s360-proyectos",
  "icon": "briefcase",
  "description": "Portal técnico y funcional del producto.",
  "order": 20
}

2. Metadata de artículo#

Cada .md puede definir:

  • categoría a la que pertenece
  • título legible
  • orden
  • icono
  • ruta de secciones del sidebar
  • slug opcional

Ese bloque se elimina antes de convertir el artículo a HTML, por lo que no contamina el contenido visible.

3. Contenido y assets#

Todo lo que esté dentro de la carpeta de categoría y no sea category.json puede convivir con los artículos:

  • imágenes
  • PDFs
  • SVG
  • ficheros auxiliares

Si se enlazan con rutas relativas desde un .md, el motor reescribe la URL para que funcionen ya publicados.

Qué genera exactamente el motor#

Por cada build se producen estos elementos:

  • home global del portal
  • home individual por categoría
  • una página HTML por cada Markdown
  • índice de búsqueda global
  • CSS y JS estáticos
  • página de callback de autenticación si CoreIAM está activo

Comportamiento de navegación#

  • El sidebar de una categoría se construye solo con los artículos de esa categoría.
  • Si varios artículos comparten la misma ruta en tags o navigation, quedan agrupados bajo la misma sección.
  • La navegación anterior y siguiente se calcula por order y slug.
  • Los breadcrumbs siempre parten de Inicio.

Comportamiento de búsqueda#

  • La búsqueda de la cabecera en Inicio es global.
  • La búsqueda lanzada dentro de una categoría no mezcla resultados de otras categorías.
  • El índice global sigue existiendo, pero la interfaz filtra por contexto de navegación.

Consejo de arquitectura

Usa una categoría por producto, solución o portal independiente. Evita mezclar familias funcionales distintas dentro de la misma categoría solo por ahorrar carpetas.

Qué no hace el motor por sí solo#

  • no protege la entrega del HTML a nivel de infraestructura
  • no gestiona versiones por rama
  • no publica automáticamente en Azure si no existe pipeline
  • no sincroniza secretos o credenciales

Eso debe resolverse en la capa de DevOps o de hosting.