User Handbook
User Handbook
Complete guide for all roles and features of the platform
Welcome to the user handbook. This handbook explains step by step how to use every feature of the platform — from initial setup to daily work with traces, policies, and compliance evidence.
Who Is This Handbook For?
The platform is used by four roles. Each page is marked with role symbols so you can quickly identify the sections relevant to you.
| Symbol | Role | Typical Tasks |
|---|---|---|
| 🔑 | Platform Admin | Set up project, manage team, configure IdP, billing, system health |
| 📋 | Compliance Officer | Register agents, classify risk, manage policies, export evidence |
| ✅ | Approval Reviewer | Approve/reject approval requests, review Command Center, evaluate Shadow AI |
| ⚙️ | Developer | Integrate SDK, set up agent keys, configure gateway, use the API |
Developer documentation: Technical integration documentation (SDKs, framework adapters, API reference) is in the separate Developer Docs. This handbook focuses on platform operation.
Quick Start by Role
You're a Platform Admin? → Start here:
You're a Compliance Officer? → Start here:
You're an Approval Reviewer? → Start here:
You're a Developer? → Start here:
- Developer Docs — Quickstart
- Trace Explorer (for debugging)
System Requirements
- Modern browser: Chrome 90+, Firefox 88+, Safari 15+, Edge 90+
- For self-hosted: Docker 24+, PostgreSQL 15+, Redis 7+
- For API integration: any HTTP client or an official SDK (TypeScript, Python, Go, Java)
Conventions Used in This Handbook
| Element | Meaning |
|---|---|
| Bold | UI elements, buttons, menu items |
Code | API endpoints, configuration values, file names |
| → | Navigation: Agents → New Agent means: click "Agents" in the menu, then "New Agent" |
| 📸 | Placeholder for a screenshot (added before launch) |
Security notice: Never commit API keys to version control systems. Use environment variables or a secrets manager.