74 lines
2.6 KiB
Markdown
74 lines
2.6 KiB
Markdown
# Slice 8: Documentation
|
|
|
|
## Status
|
|
|
|
Not started
|
|
|
|
## Objective
|
|
|
|
Make documentation accurate, non-duplicative, and sufficient for development, deployment, operation, and MVP acceptance.
|
|
|
|
## Dependencies
|
|
|
|
- Slice 7 authoritative scope
|
|
- Final behavior and validation results from Slices 1 through 6
|
|
- Continuous documentation updates from every slice
|
|
|
|
## In Scope
|
|
|
|
- Documentation ownership and consolidation
|
|
- Setup, architecture, schema, security, operations, user guidance, and release evidence
|
|
- Durable Codex and slice handoff state
|
|
|
|
## Out of Scope
|
|
|
|
- Marketing content and documentation for unimplemented post-MVP features
|
|
|
|
## Tasks
|
|
|
|
- [ ] Designate `docs/` as the authoritative specification location.
|
|
- [ ] Remove, redirect, or clearly mark duplicate root documents.
|
|
- [ ] Update README prerequisites, commands, and documentation index.
|
|
- [ ] Reconcile requirements and architecture with Slice 7.
|
|
- [ ] Update schema docs and remove new deprecated `action.responseMapping` examples.
|
|
- [ ] Document active components, bindings, and visual configuration workflows.
|
|
- [ ] Document authentication, secret provisioning, and redaction.
|
|
- [ ] Document proxy policy and deployment configuration.
|
|
- [ ] Document SQLite backup, persistence, and recovery.
|
|
- [ ] Publish verified build, test, Docker, and release commands.
|
|
- [ ] Publish the final acceptance checklist and known limitations.
|
|
- [ ] Reconcile `TASKS.md`, `CODEX.md`, and all slice handoffs.
|
|
|
|
## Acceptance Criteria
|
|
|
|
- [ ] A contributor can install, run, test, and understand the project from documentation.
|
|
- [ ] An operator can configure secrets and proxy policy without reading source.
|
|
- [ ] Schema and binding examples match validated runtime behavior.
|
|
- [ ] MVP behavior and future ideas are clearly separated.
|
|
- [ ] Duplicate authoritative documents no longer create ambiguity.
|
|
- [ ] Acceptance criteria cite verified commands and outcomes.
|
|
|
|
## Validation
|
|
|
|
- [ ] Every documented command succeeds in the target environment.
|
|
- [ ] Internal links and paths are checked.
|
|
- [ ] Example JSON validates against the schema.
|
|
- [ ] Security guidance matches actual behavior.
|
|
- [ ] Task, Codex, and slice statuses agree.
|
|
|
|
## Risks and Open Questions
|
|
|
|
- Documentation will drift without continuous updates.
|
|
- Duplicate removal must wait until links and replacements are verified.
|
|
- Security documentation must not include real secrets or unsafe examples.
|
|
|
|
## Progress Log
|
|
|
|
No work recorded yet.
|
|
|
|
## Handoff
|
|
|
|
- Last completed: Slice plan created.
|
|
- Next action: Inventory document ownership after the Slice 7 decision.
|
|
- Known blockers: Final reconciliation depends on completed behavior and validation evidence.
|