feat(docs): Add comprehensive documentation for Vexer, Vulnerability Explorer, and Zastava modules
- Introduced AGENTS.md, README.md, TASKS.md, and implementation_plan.md for Vexer, detailing mission, responsibilities, key components, and operational notes. - Established similar documentation structure for Vulnerability Explorer and Zastava modules, including their respective workflows, integrations, and observability notes. - Created risk scoring profiles documentation outlining the core workflow, factor model, governance, and deliverables. - Ensured all modules adhere to the Aggregation-Only Contract and maintain determinism and provenance in outputs.
This commit is contained in:
35
docs/modules/notify/README.md
Normal file
35
docs/modules/notify/README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# StellaOps Notify
|
||||
|
||||
Notify evaluates operator-defined rules against platform events and dispatches channel-specific payloads with full auditability.
|
||||
|
||||
## Responsibilities
|
||||
- Process event streams and apply tenant-scoped routing rules.
|
||||
- Render connector-specific payloads (email, Slack, Teams, webhook, custom).
|
||||
- Enforce throttling, digests, and delivery retries.
|
||||
- Surface delivery/audit data for UI and CLI consumers.
|
||||
|
||||
## Key components
|
||||
- `StellaOps.Notify.WebService` (rules API + preview).
|
||||
- `StellaOps.Notify.Worker` (delivery engine).
|
||||
- Connector libraries under `StellaOps.Notify.Connectors.*`.
|
||||
|
||||
## Integrations & dependencies
|
||||
- MongoDB for rule/channel storage.
|
||||
- Redis/NATS for delivery queues.
|
||||
- CLI/UI for authoring and monitoring notifications.
|
||||
|
||||
## Operational notes
|
||||
- Schema fixtures in ./resources/schemas & ./resources/samples.
|
||||
- Connector-specific monitoring dashboards.
|
||||
- Offline runner guidance inside operations playbook.
|
||||
|
||||
## Related resources
|
||||
- ./resources/schemas
|
||||
- ./resources/samples
|
||||
|
||||
## Backlog references
|
||||
- NOTIFY-SVC-38..40 (Notify backlog) referenced in `docs/README.md`.
|
||||
- DOCS-NOTIFY updates tracked in ../../TASKS.md when available.
|
||||
|
||||
## Epic alignment
|
||||
- **Epic 11 – Notifications Studio:** deliver notifications workspace, preview tooling, immutable delivery ledger, and tenant-scoped throttling/digest controls.
|
||||
Reference in New Issue
Block a user