Saltar al contenido principal

Contribuir a la documentación

Estructura de carpetas​

docs/
  intro.md              # Página de inicio (slug /)
  manuales/             # Manuales de usuario
  tecnico/              # Arquitectura, AWS IAC, quick start, diagramas
  tecnico/desarrollo/ejemplos/   # env.dev.example, docker-compose.dev.example.yml
sidebars.ts             # Menús "Manuales" y "Técnico"
docusaurus.config.ts    # Tema, búsqueda, Mermaid

Convenciones​

  • Idioma por defecto: español (i18n.defaultLocale: es).
  • Un tema por archivo; títulos claros (#, ##).
  • Capturas en static/img/ y referencia con rutas absolutas /img/....

Comandos​

cd nwi-app-conectamed-docs-core
npm install
npm start          # http://localhost:3000
npm run build    # genera build/ + índice de búsqueda local

Añadir una página al menú​

  1. Crea docs/manuales/mi-seccion/mi-pagina.md (o bajo tecnico/).
  2. Regístrala en sidebars.ts dentro de manuales o tecnico.
  3. Ejecuta npm run build para comprobar enlaces rotos.