Services¶
Reference documentation for all Musingly backend services.
Core API¶
The Core API is the primary backend service — a REST API built with Deno + Hono deployed as Supabase Edge Functions with PostgreSQL.
Content model: Journey (10-20h) → Chapter (30-60min) → Insight (5-10min)
Cross-cutting primitives: Domain (subject grouping), Beacon (discovery tags). All content supports snapshot versioning.
| Section | What's inside |
|---|---|
| Getting Started | Local setup, developer guide, usage patterns |
| API Reference | All endpoint specifications (journeys, domains, search, user, snapshots) |
| Architecture | Protection model, lineage validation, design proposals |
| Authentication | JWT lifecycle, OAuth flows, service-to-service auth |
| Configuration | Environment variables, secrets management, OAuth provider setup |
| Database | Schema, migrations, seeding, snapshot workflow |
| Deployment | Edge Function deploy, CI/CD, branching strategy, SDK publishing |
| Testing | E2E tests, test tokens, integration testing framework |
| Operations | Logging, batch import, integration pipelines |
| Troubleshooting | Common issues, Docker/Colima fixes |
Per-Service Documentation Structure¶
Each service follows this structure:
| Page | Contents |
|---|---|
| Overview | Purpose, responsibilities, and dependencies |
| API Reference | Endpoints, request/response schemas, authentication |
| Configuration | Environment variables and required secrets |
| Deployment | How to build, run, and scale the service |
| Operations | Logging, monitoring, runbooks |
| Troubleshooting | Common issues and fixes |
Contributing¶
See the contributing guide to add service documentation.