save progress
This commit is contained in:
38
docs/modules/notifier/README.md
Normal file
38
docs/modules/notifier/README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Notifier (Notifications Studio Host)
|
||||
|
||||
**Status:** Implemented
|
||||
**Source:** `src/Notifier/`
|
||||
**Owner:** Notify Guild
|
||||
|
||||
> **Note:** Notifier is the **deployment host** for the Notifications Studio. For the underlying notification toolkit (engine, storage, queue, connectors), see [`../notify/`](../notify/).
|
||||
|
||||
## Purpose
|
||||
|
||||
Notifier provides the deployable WebService and Worker that compose the Notify libraries into the Notifications Studio experience. It's the entry point for notification delivery, rule management, and delivery history.
|
||||
|
||||
## Relationship to Notify
|
||||
|
||||
| Component | Path | Purpose |
|
||||
|-----------|------|---------|
|
||||
| **Notify** | `src/Notify/` | Reusable toolkit: engine, models, connectors, queue |
|
||||
| **Notifier** | `src/Notifier/` | Host: WebService and Worker that compose Notify |
|
||||
|
||||
Per **2025-11-02 module boundary decision**: Maintain separation for packaging, offline kit parity, and cross-module governance.
|
||||
|
||||
## Components
|
||||
|
||||
**Deployables:**
|
||||
- `StellaOps.Notifier.WebService` - REST API for rules/channels CRUD, test send, delivery browsing
|
||||
- `StellaOps.Notifier.Worker` - Event consumers, evaluators, renderers, delivery workers
|
||||
|
||||
**Integration Points:**
|
||||
- Uses `StellaOps.Notify.Models`, `StellaOps.Notify.Queue`
|
||||
- Channels: Slack, Teams, Email, Webhook (via Notify connectors)
|
||||
- Storage: PostgreSQL (notify schema)
|
||||
- Queue: Valkey Streams / NATS JetStream
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- Notify Architecture: `../notify/architecture.md`
|
||||
- Authority: `../authority/` (OAuth clients)
|
||||
- Scheduler: `../scheduler/` (event sources)
|
||||
Reference in New Issue
Block a user