Add the experience service with sites through analytics/AI hooks, migrations through 0011, and phase docs/manifests marking the track complete. Co-authored-by: Cursor <cursoragent@cursor.com>
109 lines
4.3 KiB
Markdown
109 lines
4.3 KiB
Markdown
# Phase Handover — XP-Reg Experience Platform Registration
|
|
|
|
## Metadata
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Phase ID | `experience-reg` |
|
|
| Title | Experience Platform Registration |
|
|
| Status | Complete |
|
|
| Service(s) | `experience` (registered; not yet implemented) |
|
|
| Version | n/a (docs-only) |
|
|
| Date | 2026-07-25 |
|
|
| ADR(s) | [ADR-016](../architecture/adr/ADR-016.md) |
|
|
|
|
## Reusable Components
|
|
|
|
| Component | Location | Reuse notes |
|
|
| --- | --- | --- |
|
|
| Platform registration pattern | Same as Delivery DP-Reg / Sports Center | Docs + ADR + manifests before code |
|
|
| Service template | [service-template.md](../ai-framework/service-template.md) | Use in Phase 11.0 |
|
|
| Phase template | [phase-template.md](../ai-framework/phase-template.md) | Use for 11.x phase docs |
|
|
|
|
## Public APIs
|
|
|
|
| Method | Path | Auth / Permission | Notes |
|
|
| --- | --- | --- | --- |
|
|
| — | — | — | N/A — registration only; APIs begin in Phase 11.0 |
|
|
|
|
Planned surfaces (not implemented): `/health`, `/capabilities`, `/metrics`, `/api/v1/*` under `experience.*` permissions.
|
|
|
|
## Events
|
|
|
|
| Event type | Domain / Integration | Payload summary | Version |
|
|
| --- | --- | --- | --- |
|
|
| `experience.*` (planned) | Experience domain | Publish-only; catalog grows per phase | Planned |
|
|
|
|
## Extension Points
|
|
|
|
| Extension point | How to extend | Forbidden uses |
|
|
| --- | --- | --- |
|
|
| Theme packs | Theme module + versioned assets refs | Hardcoding brand tokens in code |
|
|
| Component marketplace | Versioned component registry | Binary media in Experience DB |
|
|
| Consumer connectors | Versioned REST/events for verticals | Shared DB with Hospitality/Marketplace |
|
|
| AI content hooks | Optional contracts; core works offline | Hard dependency on AI for publish |
|
|
| Bundle licensing | Entitlement keys via Core | Duplicating Core plan engine |
|
|
|
|
## Known Limitations
|
|
|
|
- No `backend/services/experience` code yet — Phase 11.0
|
|
- No Alembic migrations yet
|
|
- No compose wiring / runtime health yet
|
|
- Page Builder / public site UI deferred to frontend phases
|
|
- Vertical menu/product catalogs remain owned by Hospitality/Marketplace
|
|
- Historical `website_builder` scaffold not removed; prefer `experience` for new work
|
|
|
|
## Migration Notes
|
|
|
|
| Item | Detail |
|
|
| --- | --- |
|
|
| Alembic revision(s) | N/A (docs-only) |
|
|
| Upgrade steps | N/A |
|
|
| Downgrade support | N/A |
|
|
| Data backfill | N/A |
|
|
| Breaking changes | None |
|
|
|
|
## Dependencies
|
|
|
|
| Dependency | Type | Required for |
|
|
| --- | --- | --- |
|
|
| AI Framework | Docs | Development loop / gates |
|
|
| ADR-001 / 002 / 003 / 006 / 008 / 011 / 012 / 015 / 016 | Architecture | Boundaries |
|
|
| Core Platform | Service | Entitlement (from 11.0) |
|
|
| File Storage | Service | Media refs (from 11.5) |
|
|
| Communication | Service | Form/notify flows (later) |
|
|
|
|
## Next Phase Entry
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Recommended next phase | `experience-11.0` Foundation |
|
|
| Blockers for next phase | None for scaffold; runtime compose optional until wired |
|
|
| Entry checklist | Read this handover + [experience-roadmap.md](../experience-roadmap.md) + [ADR-016](../architecture/adr/ADR-016.md) + [service-template.md](../ai-framework/service-template.md); implement only foundation shells — no page/theme/template engines yet |
|
|
|
|
What the next phase must read and assume:
|
|
|
|
1. This handover + [experience-roadmap.md](../experience-roadmap.md)
|
|
2. Updated [module-registry.md](../module-registry.md#experience) / manifests
|
|
3. Open limitations above become Phase 11.0 scope (scaffold only)
|
|
4. Suggested next phase ID: `experience-11.0`
|
|
|
|
## Completion Sign-Off
|
|
|
|
- [x] Quality gates passed (documentation / architecture / manifest / cross-reference / links)
|
|
- [x] Tests green (N/A service pytest — docs-only; validation checks)
|
|
- [x] Documentation updated
|
|
- [x] Progress / next-steps / registries updated
|
|
- [x] No unfinished claimed deliverables
|
|
- [x] Self audit completed
|
|
|
|
## Related Documents
|
|
|
|
- [Experience Roadmap](../experience-roadmap.md)
|
|
- [Phase XP-Reg](../experience-phase-xp-reg.md)
|
|
- [Phase Area](../phases/Experience/README.md)
|
|
- [ADR-016](../architecture/adr/ADR-016.md)
|
|
- [Phase Manifest](../ai-framework/phase-manifest.yaml)
|
|
- [Service Manifest](../ai-framework/service-manifest.yaml)
|
|
- [Quality Gates](../ai-framework/quality-gates.md)
|