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
Statusfield of the template atValidatedto indicate that the procedure is part of the official manual.
How to add a procedure
- Copy
docs/plantillas/procedimiento.md. - Save it in
docs/modulos/<module>/<action>.md(Spanish) anddocs/en/modulos/<module>/<action>.md(English). - Add it to the sidebar in
docs/.vitepress/config.mtsfor both locales. - Run
npm run buildto 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.