Skip to main content

Traceo Platform Documentation

This directory contains comprehensive documentation for the Traceo platform.

Contents

DocumentDescription
architecture.mdSystem design and component overview
database-schema.mdERD, tables, and relationships
authentication.mdAuth flow and JWT handling
rbac-permissions.mdRole-based access control matrix
yaml-export-strategy.mdYAML export triggers and format
supabase-setup.mdSupabase configuration guide
development-setup.mdLocal development setup
debugging-guide.mdCommon issues and solutions
security.mdSecurity practices and guidelines
performance-benchmarks.mdRust vs Python benchmarks
migration-rollback.mdData migration procedures

API Documentation

  • api/mcp-server.md - MCP Server API reference
  • api/engine.md - Engine Server API reference

Ariel Integration

DocumentDescription
ariel-integration.mdAriel architecture, data flow, module structure
ariel-operations.mdAriel runbook: baselines, sync, recovery, migration

Runbooks

  • runbooks/incidents.md - Incident response procedures
  • runbooks/on-call.md - On-call procedures
  • runbooks/deployments.md - Deployment procedures