# Documentation
Welcome to the Inovus Notifications docs. Pick a starting point below.
| I want to… | Go here |
|---|---|
| Learn what this is and how to use it (human-friendly) | User guide |
| Copy-paste brief for a coding agent integrating V2 | AGENT.md |
| Stand up everything from scratch (DB, Cognito, Worker, CI) | Setup guide |
| Configure Cognito resource server / M2M publishers | Cognito setup |
| Understand why we rebuilt as V2 | Why V2 · User guide: Why V2? |
Keep legacy /api/Notification/* callers working |
V1 API compatibility · User guide chapter |
| Add a new database backend | Storage adapters |
| Read architecture decisions | DESIGN.md |
| Day-to-day repo commands & invariants | CLAUDE.md |
| Compact client API reference | packages/client/README.md |
Live API (when deployed): https://notifications.totumcloud.com/docs
# Start here by role
# App developer (consume / publish from a product)
- User guide — What is this?
- User guide — Getting started
- User guide — Everyday usage and Publishing
- Hand your coding agent AGENT.md (copy the whole file into its context)
# Platform / ops (new environment from zero)
- Setup guide — from zero to production ← includes Supabase/database
- Cognito setup
- User guide — Setup overview
- User guide — Developer reference
# Migrating from V1
# All docs in this folder
| File | Description |
|---|---|
| userguide/ | Progressive user guide (intro → setup → usage → advanced → developers) |
| setup.md | Complete zero-to-production: local, Supabase, Cognito, Cloudflare, GitHub Actions |
| cognito-setup.md | Resource server, scopes, app clients, tokens |
| why-v2.md | Gap-by-gap V1 → V2 comparison |
| v1-compatibility.md | Legacy HTTP contract and migration notes |
| adapters.md | Implementing NotificationStore for another DB |
| AGENT.md | Copy-paste self-contained brief for app coding agents integrating V2 |