Documentation overview
Welcome to the documentation for the application.
These docs are intended to help users and administrators understand how the system works, how to navigate it confidently, and how to complete common tasks.
You do not need to read everything from top to bottom. The documentation is structured so you can jump in at the level that matches what you are trying to understand.
Before you begin
If this is your first time using the application, it helps to understand how the system — and this documentation — is structured.
The application is designed around a small set of core ideas, and the documentation mirrors that structure.
The big picture
At a high level, the application is built around a small number of core concepts that represent the things the system manages.
Everything you see in the interface — pages, actions, and workflows — exists to create, view, or change these concepts in a controlled way.
Once you understand what these concepts are and how they relate to each other, the rest of the application should feel more predictable.
Concepts vs pages vs workflows
It can be helpful to think about the documentation in three layers:
- Concepts explain what exists in the system and why
- Pages describe where you interact with those concepts
- Workflows explain how you accomplish specific goals
If you are confused by a term, start with Concepts.
If you are confused about what a screen does or look like, look at Pages.
If you are unsure how to complete a task, follow a Workflow.
How to use this documentation
Depending on what you are trying to do, different sections will be more useful:
- If you are new to the system, start with Concepts to build a shared understanding of terminology
- If you are exploring the interface, use Pages to understand what each screen does
- If you have a specific goal in mind, follow a Workflow for step-by-step guidance
You can move between these sections freely — they are designed to reference each other.