How to use this manual
The manual is written for operational and administrative users. Each page documents a concrete action of the system.
Format of each procedure
Each action keeps the same structure:
- Objective: what it achieves.
- Before starting: permissions, data or configurations needed.
- Step by step: numbered instructions.
- Expected result: how to confirm the action worked.
- Common errors: frequent situations and how to resolve them.
How to update it
When a screen or flow changes, edit only the file of the affected procedure. If a new functionality is added, create a new page inside the corresponding module and add it to the sidebar in docs/.vitepress/config.mts.
Screenshots
Save the images in docs/public/images/ and reference them like this:
md
Pending validations
Mark any behavior that could not be confirmed against code or screen as:
Pending validation.
Pending screenshots
When a screenshot is missing, add the marker:
Pending: add screenshot of [screen/process].