Ilia Denisov
26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
# Notification Service Docs
|
|
|
|
This directory keeps service-local documentation that is more operational or
|
|
more example-heavy than [`../README.md`](../README.md).
|
|
|
|
Sections:
|
|
|
|
- [Runtime and components](runtime.md)
|
|
- [Main flows](flows.md)
|
|
- [Operator runbook](runbook.md)
|
|
- [Configuration and contract examples](examples.md)
|
|
|
|
Primary references:
|
|
|
|
- [`../README.md`](../README.md) for stable service scope, contracts, data
|
|
model, Redis layout, and retry policy
|
|
- [`../api/intents-asyncapi.yaml`](../api/intents-asyncapi.yaml) for the
|
|
producer-to-notification Redis Stream contract
|
|
- [`../openapi.yaml`](../openapi.yaml) for the private probe HTTP contract
|
|
- [`../../gateway/README.md`](../../gateway/README.md) for client-event fan-out
|
|
- [`../../mail/api/delivery-commands-asyncapi.yaml`](../../mail/api/delivery-commands-asyncapi.yaml)
|
|
for the trusted async generic mail command contract
|
|
- [`../../ARCHITECTURE.md`](../../ARCHITECTURE.md) for system-level service
|
|
boundaries and transport rules
|
|
- [`../../TESTING.md`](../../TESTING.md) for the cross-service testing matrix
|