Skip to content

Documentation structure

The documentation is separated from the Angular frontend to avoid coupling with the application's deployment cycle.

txt
AgendaIntegralDocs/
  package.json
  docs/
    .vitepress/
      config.mts
      theme/
        custom.css
    modulos/
      agenda/
      pacientes/
      caja/
    en/
      modulos/
        agenda/
        pacientes/
        caja/
    plantillas/
      procedimiento.md
    public/
      assets/

Good practices

  • One file per user action.
  • Verb-imperative titles: Create appointment, Reschedule appointment, Cancel appointment.
  • Avoid mixing internal rules with user instructions.
  • Use tables only for errors, permissions or fields.
  • Keep screenshots per module.
  • Keep the Status field of the template at Validated to indicate that the procedure is part of the official manual.

How to add a procedure

  1. Copy docs/plantillas/procedimiento.md.
  2. Save it in docs/modulos/<module>/<action>.md (Spanish) and docs/en/modulos/<module>/<action>.md (English).
  3. Add it to the sidebar in docs/.vitepress/config.mts for both locales.
  4. Run npm run build to validate links and syntax.

Internationalization

The site is bilingual (Spanish as root locale, English under /en/). Sidebars and theme text are configured per locale in config.mts. Keep the slug structure parallel between both languages to make it easy to keep content in sync.