Version documentation index and contracts

This commit is contained in:
Luna 2026-06-16 04:14:26 -07:00
parent 7a176ea238
commit aee984d862
8 changed files with 115 additions and 2 deletions

View file

@ -1,5 +1,9 @@
# Enodia Sentinel Command Reference
Applies to package version: `0.7.0`
Docs version: `0.7`
Schema generation: `v1`
This is the operator-facing command contract for the current local agent. Commands
are intentionally plain: they either inspect state, manage baselines, run the
daemon, or expose existing evidence.

38
docs/INDEX.md Normal file
View file

@ -0,0 +1,38 @@
# Enodia Sentinel Documentation Index
Applies to package version: `0.7.0`
Docs version: `0.7`
Schema generation: `v1`
This index is the versioned entry point for local operator documentation. When
the package version changes, update `docs/VERSION.json` and this file in the
same patch as any command, schema, or behavior documentation changes.
## Operator References
| Document | Purpose |
|---|---|
| [COMMAND_REFERENCE.md](COMMAND_REFERENCE.md) | Manpage-style CLI and service command contract. |
| [SCHEMAS.md](SCHEMAS.md) | Stable JSON schema IDs and required v1 fields. |
| [OPERATIONS.md](OPERATIONS.md) | Install checks, health checks, alert workflow, baseline hygiene, and evidence export. |
| [RUNBOOKS.md](RUNBOOKS.md) | Incident response playbooks for common Sentinel findings. |
| [RULES.md](RULES.md) | Generated built-in event-rule reference by SID. |
## Product and Security References
| Document | Purpose |
|---|---|
| [SPECIFICATION.md](SPECIFICATION.md) | Product model, current scope, data model, and acceptance criteria. |
| [ROADMAP.md](ROADMAP.md) | Release tracks and planned sequencing. |
| [THREAT_MODEL.md](THREAT_MODEL.md) | Trust boundaries, attacker assumptions, and non-goals. |
## Versioning Rules
- Documentation tracks the package minor line, not individual commits.
- Additive JSON fields are allowed within a schema generation; required v1
fields stay stable.
- Command behavior changes must update [COMMAND_REFERENCE.md](COMMAND_REFERENCE.md).
- New operator-facing JSON contracts must update [SCHEMAS.md](SCHEMAS.md) and
compatibility tests.
- Roadmap checkboxes should only be marked complete after code, docs, and tests
all reflect the shipped behavior.

View file

@ -92,7 +92,7 @@ Purpose: define a stable single-host product.
- ✅ Commit to stable JSON schemas for alerts, incidents, status, and response
audits.
- ✅ Add compatibility tests for schema evolution.
- Add documentation versioning and manpage-style command reference.
- Add documentation versioning and manpage-style command reference.
- Harden packaging for Arch first, then document Debian/RPM install paths.
- Add signed release artifacts and checksums.
- Improve dashboard from alert browser to local console:

View file

@ -1,5 +1,9 @@
# Enodia Sentinel JSON Schemas
Applies to package version: `0.7.0`
Docs version: `0.7`
Schema generation: `v1`
Sentinel uses stable schema IDs for operator-facing JSON contracts. These IDs
are lightweight compatibility markers, not external JSON Schema files. The v1
rule is additive: future releases may add fields, but required v1 fields should

8
docs/VERSION.json Normal file
View file

@ -0,0 +1,8 @@
{
"project": "enodia-sentinel",
"package_version": "0.7.0",
"docs_version": "0.7",
"schema_generation": "v1",
"command_reference": "docs/COMMAND_REFERENCE.md",
"schema_reference": "docs/SCHEMAS.md"
}