Skip to content

index.md

Latest commit

 

History

History
188 lines (171 loc) · 20.2 KB

index.md

File metadata and controls

188 lines (171 loc) · 20.2 KB
Raw

ABOUTME: Entry point for project documentation with high-signal navigation only. ABOUTME: Prioritizes non-inferable rules and operational docs over generated or repetitive detail.

Documentation Index

Audience: Operators | Contributors | Admins | Integrators | AI agents Status: Implemented Owner: Contributor Experience Last Verified: 2026-08-29 Source Anchors: ../../README.md, DOCUMENTATION_ARCHITECTURE.md, DOCUMENTATION_STYLE_GUIDE.md

Start with Repository README or the Documentation Hub if you are new to the project. Use this page when you already know your task or need the complete internal engineering documentation inventory.

📖 Official Hosted Documentation: Looking for online guides, tutorials, and hosted manuals? Visit the Official Documentation Portal or browse docs/public/.

Task Paths

I need to... Start Here Then Read
Browse hosted platform guides & tutorials Official Documentation Docs Hub, DEVELOPER_GUIDE.md
Understand the whole codebase & mental model DEVELOPER_GUIDE.md ARCHITECTURE_OVERVIEW.md, REQUEST_FLOWS.md
Follow step-by-step feature recipes CONTRIBUTOR_RECIPES.md QUICK_REFERENCE.md, TESTING.md
Understand the product and current scope PROJECT.md ARCHITECTURE_OVERVIEW.md, SECURITY-MODEL.md
Run the app locally GETTING_STARTED.md TESTING.md, TROUBLESHOOTING.md
Self-host or operate a deployment SELF_HOSTING.md CONFIGURATION.md, SECRETS.md, OPERATIONS.md, BACKUP_RESTORE_UPGRADE.md
Bootstrap instance and tenant configuration CONFIGURATION_MANIFEST.md CONFIGURATION.md, SELF_HOSTING.md, SECRETS.md, TROUBLESHOOTING.md
Troubleshoot a failure TROUBLESHOOTING.md OPERATIONS.md, CONFIGURATION.md, TEST_RELIABILITY.md
Prepare a governed release RELEASE_CHECKLIST.md RELEASE_POLICY.md, RELEASE_RUNBOOK.md, ADR-025
Configure tenants, admins, or branding ADMIN_GUIDE.md ADMIN_HIERARCHY.md, DEPLOYMENT_MODES.md, MULTI_TENANCY.md
Configure payments or add a payment provider PAYMENTS.md CONFIGURATION.md, SECRETS.md, ADR-022
Understand registration, admission credentials, or recovery ADMISSION_AND_REGISTRATION.md API.md, SECURITY-MODEL.md, ADR-023
Integrate with the API API_COOKBOOK.md API.md, WEBHOOKS.md, INTEGRATIONS.md, API_CHANGELOG.md, SECURITY-MODEL.md
Change authorization or Cerbos behavior AUTHORIZATION.md AUTHORIZATION_PATTERNS.md, SECURITY-MODEL.md, OPERATIONS.md
Contribute code or docs DEVELOPER_GUIDE.md CONTRIBUTOR_RECIPES.md, CONTRIBUTING.md, QUICK_REFERENCE.md
Choose records, classes, or generated contract shapes RECORD_CONTRACTS.md GOVERNANCE.md, ARCHITECTURE.md, TESTING.md
Research external behavior or assess a dependency license IP Governance CLA, Mapperly provenance, CI/CD Governance
Work on Blazor UI BLAZOR.md DESIGN_SYSTEM.md, ACCESSIBILITY.md, RENDER_POLICIES.md
Use an AI coding agent or understand context engineering AGENTIC_CONTEXT_ENGINEERING.md ../../AGENTS.md, ../../.agents/contract/intents.yaml, QUICK_REFERENCE.md

How To Use This Index

  • Prefer the task path first, then use the full inventory below only when you need a specific reference.
  • Treat how-to pages as workflows and reference pages as the exact source for keys, contracts, commands, and runtime behavior.
  • If two docs disagree, prefer the page with source anchors to code, infrastructure, tests, or workflows, then fix the stale page.

Read First

Core Architecture

  • ARCHITECTURE_OVERVIEW.md - high-level visual architecture, C4 diagrams, and component interactions.
  • REQUEST_FLOWS.md - end-to-end request lifecycles with sequence diagrams.
  • ARCHITECTURE.md - layer boundaries, BFF model, CQRS flow.
  • RECORD_CONTRACTS.md - record/class selection, immutable results and collections, semantic values, persistence checks, and generated C# contracts.
  • DOMAIN.md - domain entities and important relationships.
  • ADMISSION_AND_REGISTRATION.md - registration order lifecycle, entitlement materialization, and zero-knowledge admission credentials.
  • API.md - API conventions, HAL behavior, filters, caching, error shape.
  • API_CONTRACT_INVENTORY.md - generated inventory of every OpenAPI operation.
  • API_CONTRACT_TEST_DEBT.md - governed inventory of intentionally skipped API contract tests and removal criteria.
  • API_COOKBOOK.md - task-first API integration guidance.
  • BLAZOR.md - client architecture, render policy, service patterns.
  • DOCK_LAYOUT.md - dock engine, responsive behavior, shell/workspace stacking, inspector overlays, and persistence.
  • OUTBOX_PATTERN.md - transactional outbox, retry, dead-letter.
  • FOOTER_MANAGEMENT.md - footer data model, templates, governance.
  • CUSTOM_PROPERTIES.md - Layer 3 custom-property governance, projections, templates, purge, export/moderation boundaries.
  • PAYMENTS.md - provider-neutral payment architecture, OrganizerDirect, and checkout flows.
  • DESIGN_SYSTEM.md - CSS layers, tokens, wrapper components.

Governance And Rules

AI Agent Contribution Context

Runtime And Operations

  • CONFIGURATION_MANIFEST.md - strict instance-and-tenant bootstrap contract, operator workflow, rerun semantics, export, recovery, and contributor extension guide.
  • CONFIGURATION.md - environment/config settings and secret providers.
  • SECRETS.md - multi-provider secret management (Explore.Secrets library).
  • STORAGE.md - local-first object storage, optional S3-compatible configuration, reconciliation, API boundaries, and backup impact.
  • EMAIL_NOTIFICATIONS.md - SMTP email delivery and its boundary from in-app notifications.
  • NOTIFICATIONS.md - in-app notification lifecycle, inbox UI, and API boundaries.
  • WEBHOOKS.md - outgoing webhook providers, LocalProvider/SvixProvider setup, signatures, health, and rollout.
  • WEBHOOK_OPERATIONS_RUNBOOK.md - webhook readiness, bounded metrics, SLOs, alerts, and Local/self-hosted Svix incident recovery.
  • PAYMENTS.md - payment provider configuration, Stripe Connect platform secrets, and readiness reconciliation.
  • INTEGRATIONS.md - incoming provider callbacks, Coop/Osprey/Svix operational verification, and idempotency.
  • Google Forms Pub/Sub Integration - Google Forms OAuth scopes, Pub/Sub OIDC setup, renewal/sweep behavior, and unsupported Drive/file boundaries.
  • SEO.md - sitemap, robots, render-policy, and public-discovery SEO behavior.
  • SECURITY_OVERVIEW.md - auth/authz model and trust boundaries.
  • SECURITY-MODEL.md - platform security invariants, privilege isolation, and privacy boundaries.
  • PRIVACY_ERASURE.md - Privacy Erasure Authority, concrete meaning, storage topologies (EmbeddedSqlite, CoLocated, ExternalDatabase), independent restore-isolation rationale, and self-hoster decision guide.
  • OPERATIONS.md - deployment, health, observability.
  • TESTING.md - TUnit framework, test projects, TDD workflow.
  • TEST_RELIABILITY.md - flaky/deferred runtime, stress, and manual-test tracking.
  • BENCHMARKS.md - BenchmarkDotNet runtime benchmarks, API pipeline benchmarks, PostgreSQL/Testcontainers benchmark runs, and cold-start agent benchmark boundaries.
  • AGENTIC_CONTEXT_ENGINEERING.md - authoritative visual guide to the agentic context engineering system, cold-start lifecycle, multi-harness bootloaders, twin rules, dev-doc triad, and QA evidence gates.
  • AI_RAG_FOUNDATION.md - tenant-safe summary-only boundary for future AI vector/RAG support.
  • AI_AGENT_CONTRACT_INVENTORY.md - generated inventory of registry-governed AI agent tool contracts.
  • AI_AGENT_EXPERIENCE_HARDENING.md - guarded context summaries, proposal-only plan previews, and fake/replay AI usability reports.
  • HOSTING_ARCHITECTURE.md - composition roots (Explore.API, Explore.Blazor, Event.Standalone, Event.MigrationService), startup lifecycle phases, and provider abstraction.
  • SELF_HOSTING.md - internal hosting specification, headless onboarding, and operator identity gates (for operator runbooks, see public docs).
  • CERBOS_COOLIFY.md - Coolify deployment specification for external Cerbos PDP and PostgreSQL storage schema.
  • BACKUP_RESTORE_UPGRADE.md - backup, restore, upgrade, and rollback runbook.
  • RELEASE_CHECKLIST.md - release readiness and documentation contract.
  • TROUBLESHOOTING.md - practical issue resolution.
  • DEPLOYMENT_MODES.md - single-tenant vs multi-tenant runtime behavior.
  • DEPLOYMENT_TIERS.md - infrastructure tier choices.

Multi-Tenancy And Platform Control

Extensibility And Federation

Reference And Change History