Add draft skeletons for various documentation topics
- Created draft documentation for enabling reachability, CLI authentication, EntryTrace heuristics, Go stripped binaries, Java and Python lockfiles, Rust fingerprint enrichment, SAST integration, Windows/macOS analyzer coverage, scanner engine surface, multi-tenancy operations, RLS and data isolation, ABAC overlays, VEX trust model, VEX ops runbook, VEX mapping, scopes and roles, tenancy overview, VEX signatures, contract testing, VEX consensus algorithm, VEX consensus API, VEX consensus console, VEX consensus overview, and VEX issuer directory. - Each document includes a status placeholder, purpose, and open TODOs for future updates.
This commit is contained in:
15
docs/vex/consensus-algorithm.md
Normal file
15
docs/vex/consensus-algorithm.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# VEX Consensus Algorithm — Draft Skeleton (2025-12-05 UTC)
|
||||
|
||||
Status: draft placeholder. Depends on consensus overview and PLVL0102.
|
||||
|
||||
## Normalization
|
||||
- Input normalization steps (pending schema).
|
||||
|
||||
## Weighting & Thresholds
|
||||
- How weights are assigned; threshold examples (to fill).
|
||||
|
||||
## Examples
|
||||
- Sample merge scenarios (placeholder).
|
||||
|
||||
## Open TODOs
|
||||
- Populate equations and concrete scenarios when data is available.
|
||||
15
docs/vex/consensus-api.md
Normal file
15
docs/vex/consensus-api.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# VEX Consensus API — Draft Skeleton (2025-12-05 UTC)
|
||||
|
||||
Status: draft placeholder. Inputs pending: PLVL0102 policy join notes.
|
||||
|
||||
## Endpoints
|
||||
- List and describe endpoints (to fill).
|
||||
|
||||
## Query Parameters
|
||||
- Filters, pagination, projections (pending contract).
|
||||
|
||||
## Rate Limits
|
||||
- TBD; add concrete values once agreed.
|
||||
|
||||
## Open TODOs
|
||||
- Add request/response examples when schemas are delivered.
|
||||
12
docs/vex/consensus-console.md
Normal file
12
docs/vex/consensus-console.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# VEX Consensus Console — Draft Skeleton (2025-12-05 UTC)
|
||||
|
||||
Status: draft placeholder. Inputs pending: console overlay assets.
|
||||
|
||||
## Workflows
|
||||
- Browse/filters; conflict resolution; accessibility notes.
|
||||
|
||||
## Notifications
|
||||
- How conflicts/exceptions surface in UI.
|
||||
|
||||
## Open TODOs
|
||||
- Add screenshots/flows when assets arrive.
|
||||
15
docs/vex/consensus-overview.md
Normal file
15
docs/vex/consensus-overview.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# VEX Consensus Overview — Draft Skeleton (2025-12-05 UTC)
|
||||
|
||||
Status: draft placeholder. Inputs pending: PLVL0102 schema snapshot, issuer directory details.
|
||||
|
||||
## Purpose
|
||||
- Explain why consensus exists and what assurances it provides (AOC scope).
|
||||
|
||||
## Inputs
|
||||
- Evidence sources (attestations, SBOM edges) — to be confirmed.
|
||||
|
||||
## Outputs
|
||||
- Decision artifacts; confidence/threshold handling.
|
||||
|
||||
## Open TODOs
|
||||
- Fill concrete schema references and examples once PLVL0102 arrives.
|
||||
15
docs/vex/issuer-directory.md
Normal file
15
docs/vex/issuer-directory.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# VEX Issuer Directory — Draft Skeleton (2025-12-05 UTC)
|
||||
|
||||
Status: draft placeholder. Inputs pending: issuer directory keys/overrides, audit model.
|
||||
|
||||
## Management
|
||||
- Add/update issuers; key material handling (to be filled).
|
||||
|
||||
## Trust Overrides
|
||||
- Local overrides, expiry/rotation rules.
|
||||
|
||||
## Audit
|
||||
- Recording changes; export/logging expectations.
|
||||
|
||||
## Open TODOs
|
||||
- Insert concrete commands/APIs once available.
|
||||
Reference in New Issue
Block a user