Help & Documentation
Guided instructions and manuals for the AI Assistant platform.
Getting Started
The AI Assistant is designed to automate complex engineering and operations workflows. To get started, we recommend exploring the **User Manual** which contains detailed instructions on every module.
Available Documentation
- User Manual:
AI_ASSISTANT_USER_MANUAL.md - Technical Specs:
PHASE_2_MONITORING_IMPLEMENTATION_REPORT.md - Audit Logs:
OPERATIONS_ASSISTANT_AUDIT_REPORT.md
Common Workflows
Open Operations > AI Solution Architect, type I want to build a school platform, answer the guided questions, approve the architecture, then generate the application without writing technical requirements.
Start workflowNavigate to Document Intelligence, drag a .md file onto the upload zone, and click Upload. Use the Q&A panel to ask questions.
Go to Operations > Customers & Sites. Click 'Add Site', enter the URL, and ensure the Scheduler is running on the Command Center.
Use /login with the local development admin credentials configured in the backend .env file. The admin_session cookie is required for backups and restores.
Open /backups, create a backup, inspect the archive metadata, and only restore after typing the required confirmation phrase.
Create a safe update session, capture pre-update evidence, mark the update completed, then run post-update verification and comparison.
Open Operations > Background Browser Test Worker to create localhost Playwright checks, approve authenticated tasks, read reports, and generate Codex fix tasks from failures.
Use Operations Setup Assistant examples such as Monitor annuvell.co.uk every 15 minutes, then approve the proposed setup before checks run.
Set OpenAI, Anthropic, or Ollama variables locally for AI-backed chat, documents, research, and coding. The UI never reveals secret values.
Need Support?
If you encounter a bug or have a feature request, please use the internal ticket system.
Create Support TicketPro Tip
Use the Command Palette (Ctrl + K) to quickly jump between different project areas and search through your documents.