Guía de Desarrollador

Manual técnico para desarrolladores y mantenedores de WikiRegional.

Estructura de Carpetas

docs/
├── comenzando/              # Sección "Comenzando"
│   ├── index.mdx            # Página principal de la sección
│   ├── guia-usuario/
│   │   └── index.mdx
│   └── guia-desarrollador/
│       └── index.mdx
├── modulos/                 # Sección "Módulos"
│   ├── index.mdx
│   ├── proveedores/
│   │   └── index.mdx
│   └── nucleo/
│       └── index.mdx

Sistema de Secciones en Sidebar

La barra lateral agrupa documentos en secciones con iconos y colores distintivos.

Cómo funciona

1. Cada carpeta de primer nivel en docs/ se convierte en una sección
2. Las secciones se configuran en src/lib/docsTree.ts
3. Documentos anidados aparecen dentro de su sección padre

Configurar una nueva sección

Editar src/lib/docsTree.ts y agregar al objeto SECTION_CONFIG:

const SECTION_CONFIG = {
  comenzando: { title: 'Comenzando', order: 1, icon: '🚀', color: 'teal' },
  modulos: { title: 'Módulos', order: 2, icon: '📦', color: 'blue' },
  servicios: { title: 'Servicios Externos', order: 3, icon: '🔗', color: 'orange' },
  // Agregar nueva sección:
  integraciones: { title: 'Integraciones', order: 4, icon: '🔌', color: 'purple' },
};

Propiedades de sección

Propiedad	Descripción
title	Nombre que aparece en el sidebar
order	Orden de aparición (menor = primero)
icon	Emoji que aparece junto al título
color	Color del tema: teal, blue, orange, purple, gray

Colores disponibles

• teal - Verde azulado (#14b8a6)
• blue - Azul (#3b82f6)
• orange - Naranja (#f97316)
• purple - Púrpura (#a855f7)
• gray - Gris (por defecto)

Agregar un documento

1. Crear carpeta en la sección deseada: docs/modulos/mi-doc/
2. Crear index.mdx con frontmatter:

---
title: Mi Documento
description: Descripción breve
order: 1
status: published
---

3. Agregar imágenes en docs/modulos/mi-doc/images/

Frontmatter disponible

Campo	Tipo	Requerido	Descripción
title	string	✅	Título del documento
description	string	❌	Descripción corta
order	number	❌	Orden en el sidebar
status	enum	❌	published, draft, deprecated
tags	string[]	❌	Etiquetas para búsqueda
related	string[]	❌	Documentos relacionados

Comandos útiles

npm run dev          # Desarrollo local
npm run build:quick  # Build sin PDFs
npm run build        # Build completo con PDFs

Búsqueda

La búsqueda usa Pagefind y solo funciona después de un build:

npm run build:quick  # Genera índice de búsqueda
npx serve dist       # Preview con búsqueda funcional