Project Documentation¶
Technical documentation for CampusCore developers. Each doc covers a major feature or subsystem.
Contents¶
| Doc | Description |
|---|---|
| Agent & Retrieval System | Agentic RAG pipeline, two retrieval tools (search_attachments vs search_knowledge), attachment handling, knowledge routing, streaming events |
| Connector System | Plugin architecture for external service integrations (OAuth2, actions, cloud drive imports) |
| Connector Philosophy | The why behind how we build connectors — hand-roll vs. MCP, action surface curation, return shapes, versioning, permission gating |
| Settings Page | Unified settings UI with role-gated sidebar navigation and AppConfig model |
| Multi-Client Architecture | BYOC deployment model, setup wizard, dynamic branding, and agent prompt templating |
| Subdomain Provisioning | Automatic {env}.campuscoreai.com subdomain + ACM SSL, custom domain two-path SSL modes |
| HTMX Auth Pattern | HTMX-safe auth decorators (HX-Redirect instead of 302) to prevent full-page swaps into partial targets |
| Observability Stack | Architecture overview — where errors / metrics / traces / logs go, and how Sentry, CloudWatch, Slack notifications, and the in-app admins fit together |
| Agent Observability | OTel-based agent tracing — GenAI-conventions span hierarchy, agent-run filtering, PostgreSQL admin storage, Sentry bridge, golden-signal metrics |
| Vector Index Observability | pgvector / HNSW health dashboard at /admin/observability/vector/, the seven metrics, EventBridge auto-rebuild schedule, maintenance log + runbook |
| Security & SOC 2 Compliance | Encryption at rest/in transit, WAF at the ALB edge, FERPA data handling, Sentry PII scrubber, Fernet credential encryption, CI policy enforcement |
| RBAC & Feature Flags | SSO-driven roles, role-scoped knowledge folders, two-axis feature flags (CampusCore-availability + institution-enablement), platform-vs-institution admin boundary |
| Adding a Feature Flag | Developer how-to: register, sync, gate, and test a new feature flag end-to-end |
| Document Pipeline | Full design for the ingest pipeline — load envelopes, decisions (Modal/Lambda → in-process Fargate, two-queue priority, S3-staging, read replica, rate budget), target architecture, phasing |
| Ingest State Machine | Engineer reference: step diagram, error categories, retry semantics, how to add a new step |
| Runtime Verification | Why static checks don't prove the system runs, and a pointer to the runtime_validation skill that owns the runnable per-surface recipes (stack-up, real-HTTP UI/endpoint checks, SSE agent, upload pipeline, Terraform) |
Docs are added incrementally as features are built or updated.