docs consolidation work
This commit is contained in:
@@ -48,3 +48,29 @@ Excititor converts heterogeneous VEX feeds into raw observations and linksets th
|
||||
- **Epic 1 – AOC enforcement:** maintain immutable VEX observations, provenance, and AOC verifier coverage.
|
||||
- **Epic 7 – VEX Consensus Lens:** supply trustworthy raw inputs, trust metadata, and consensus hooks for the lens computations.
|
||||
- **Epic 8 – Advisory AI:** expose citation-ready VEX payloads for the advisory assistant pipeline.
|
||||
|
||||
## Implementation Status
|
||||
|
||||
### Objectives
|
||||
- Maintain deterministic behaviour and offline parity across releases
|
||||
- Keep documentation, telemetry, and runbooks aligned with the latest sprint outcomes
|
||||
|
||||
### Key Milestones
|
||||
- **Epic 1 – AOC enforcement:** enforce immutable VEX observation schema, provenance capture, and guardrails
|
||||
- **Epic 7 – VEX Consensus Lens:** provide lens-ready metadata (issuer trust, temporal scoping) and consensus APIs
|
||||
- **Epic 8 – Advisory AI:** guarantee citation-ready payloads and normalized context for AI summaries/explainers
|
||||
|
||||
### Recent Delivery Status
|
||||
- Chunk API documentation remains blocked until CI is green and a pinned OpenAPI spec with deterministic samples are available
|
||||
- Link-Not-Merge readiness and consensus beta completed with DSSE packaging guidance
|
||||
- Observability guide additions and policy/CLI follow-ups tracked in sprint files
|
||||
|
||||
### Workstreams
|
||||
- Backlog grooming: reconcile open stories with module roadmap
|
||||
- Implementation: collaborate with service owners to land feature work
|
||||
- Validation: extend tests/fixtures to preserve determinism and provenance requirements
|
||||
|
||||
### Coordination
|
||||
- Review ./AGENTS.md before picking up new work
|
||||
- Sync with cross-cutting teams noted in sprint files
|
||||
- Update plan whenever scope, dependencies, or guardrails change
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
# Implementation plan — Excititor
|
||||
|
||||
## Current objectives
|
||||
- Maintain deterministic behaviour and offline parity across releases.
|
||||
- Keep documentation, telemetry, and runbooks aligned with the latest sprint outcomes.
|
||||
|
||||
## Workstreams
|
||||
- Backlog grooming: reconcile open stories in ../../TASKS.md with this module's roadmap.
|
||||
- Implementation: collaborate with service owners to land feature work defined in SPRINTS/EPIC docs.
|
||||
- Validation: extend tests/fixtures to preserve determinism and provenance requirements.
|
||||
|
||||
## Epic milestones
|
||||
- **Epic 1 – AOC enforcement:** enforce immutable VEX observation schema, provenance capture, and guardrails.
|
||||
- **Epic 7 – VEX Consensus Lens:** provide lens-ready metadata (issuer trust, temporal scoping) and consensus APIs.
|
||||
- **Epic 8 – Advisory AI:** guarantee citation-ready payloads and normalized context for AI summaries/explainers.
|
||||
- Track DOCS-LNM-22-006/007 and CLI-EXC-25-001..002 in ../../TASKS.md.
|
||||
|
||||
## Coordination
|
||||
- Review ./AGENTS.md before picking up new work.
|
||||
- Sync with cross-cutting teams noted in `/docs/implplan/SPRINT_*.md`.
|
||||
- Update this plan whenever scope, dependencies, or guardrails change.
|
||||
|
||||
## Sprint alignment (2025-11-30)
|
||||
|
||||
| Sprint task | State (SPRINT_0333_0001_0001_docs_modules_excititor) | Notes |
|
||||
| --- | --- | --- |
|
||||
| EXCITOR-DOCS-0001 | DONE | README release alignment + consensus beta references refreshed (DSSE/export guidance). |
|
||||
| EXCITOR-ENG-0001 | DONE | Implementation plan mirrored to sprint status; TASKS board created. |
|
||||
| EXCITOR-OPS-0001 | DONE | Runbook/observability checklist added to `mirrors.md`. |
|
||||
| EXCITITOR-DOCS-0001 | BLOCKED | Waiting on chunk API CI validation + OpenAPI freeze. |
|
||||
| EXCITITOR-ENG-0001 | TODO | Will update engineering notes once DOCS unblock. |
|
||||
| EXCITITOR-OPS-0001 | TODO | Sync observability/runbook updates after OpenAPI freeze. |
|
||||
|
||||
See `/docs/implplan/SPRINT_0333_0001_0001_docs_modules_excititor.md` for the canonical status table.
|
||||
Reference in New Issue
Block a user