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:
		| @@ -452,14 +452,14 @@ Planned for Q1‑2026 (kept here for early plug‑in authors). | ||||
|  | ||||
| ## 6 Notify Foundations (Rule · Channel · Event) | ||||
|  | ||||
| *Sprint 15 target* – canonically describe the Notify data shapes that UI, workers, and storage consume. JSON Schemas live under `docs/notify/schemas/` and deterministic fixtures under `docs/notify/samples/`. | ||||
| *Sprint 15 target* – canonically describe the Notify data shapes that UI, workers, and storage consume. JSON Schemas live under `docs/modules/notify/resources/schemas/` and deterministic fixtures under `docs/modules/notify/resources/samples/`. | ||||
|  | ||||
| | Artifact | Schema | Sample | | ||||
| |----------|--------|--------| | ||||
| | **Rule** (catalogued routing logic) | `docs/notify/schemas/notify-rule@1.json` | `docs/notify/samples/notify-rule@1.sample.json` | | ||||
| | **Channel** (delivery endpoint definition) | `docs/notify/schemas/notify-channel@1.json` | `docs/notify/samples/notify-channel@1.sample.json` | | ||||
| | **Template** (rendering payload) | `docs/notify/schemas/notify-template@1.json` | `docs/notify/samples/notify-template@1.sample.json` | | ||||
| | **Event envelope** (Notify ingest surface) | `docs/notify/schemas/notify-event@1.json` | `docs/notify/samples/notify-event@1.sample.json` | | ||||
| | **Rule** (catalogued routing logic) | `docs/modules/notify/resources/schemas/notify-rule@1.json` | `docs/modules/notify/resources/samples/notify-rule@1.sample.json` | | ||||
| | **Channel** (delivery endpoint definition) | `docs/modules/notify/resources/schemas/notify-channel@1.json` | `docs/modules/notify/resources/samples/notify-channel@1.sample.json` | | ||||
| | **Template** (rendering payload) | `docs/modules/notify/resources/schemas/notify-template@1.json` | `docs/modules/notify/resources/samples/notify-template@1.sample.json` | | ||||
| | **Event envelope** (Notify ingest surface) | `docs/modules/notify/resources/schemas/notify-event@1.json` | `docs/modules/notify/resources/samples/notify-event@1.sample.json` | | ||||
|  | ||||
| ### 6.1 Rule highlights (`notify-rule@1`) | ||||
|  | ||||
| @@ -498,12 +498,12 @@ Planned for Q1‑2026 (kept here for early plug‑in authors). | ||||
|  | ||||
| ```bash | ||||
| # Validate Notify schemas and samples (matches Docs CI) | ||||
| for schema in docs/notify/schemas/*.json; do | ||||
| for schema in docs/modules/notify/resources/schemas/*.json; do | ||||
|   npx ajv compile -c ajv-formats -s "$schema" | ||||
| done | ||||
|  | ||||
| for sample in docs/notify/samples/*.sample.json; do | ||||
|   schema="docs/notify/schemas/$(basename "${sample%.sample.json}").json" | ||||
| for sample in docs/modules/notify/resources/samples/*.sample.json; do | ||||
|   schema="docs/modules/notify/resources/schemas/$(basename "${sample%.sample.json}").json" | ||||
|   npx ajv validate -c ajv-formats -s "$schema" -d "$sample" | ||||
| done | ||||
| ``` | ||||
|   | ||||
		Reference in New Issue
	
	Block a user