2.3 KiB
2.3 KiB
| id | slug | title | status | kind | priority | labels | created_at | updated_at | assignee | legacy_ticket | ||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 20260530-062852-refresh-stale-docs | refresh-stale-docs | Docs: refresh stale architecture and operation docs | closed | task | P2 |
|
2026-05-30T06:28:52Z | 2026-05-30T06:39:41Z | null | null |
Background
Read-only docs audit Pod docs-stale-audit-20260530 reported that several high-level docs still describe older protocol/session/tool/TUI behavior. The stale content is concentrated in architecture, compaction, TUI keybindings, and older plan documents.
The current authoritative sources are the code, work-items/, KNOWN_ISSUES.md, AGENTS.md, and git history. docs/report/ remains historical observations, not current spec authority.
Scope
Update or clearly demote stale docs so readers do not mistake old plans for current behavior:
docs/architecture.md- Refresh Protocol Method/Event overview.
- Refresh session persistence description for current
session_id/segment_id/SegmentOrigin/ Pod metadata split. - Refresh built-in tools description beyond only file tools.
- Clarify the coarse
1 Pod = 1 process = 1 sessionstatement after Pod metadata / session / segment separation.
docs/compaction.md- Refresh compact/session/segment descriptions to match current session-store and segment semantics.
docs/tui-keybindings.md- Refresh
Ctrl-Rbehavior and current command/queue/completion controls.
- Refresh
docs/plan/llm_presistence.md- Mark as superseded/archival or replace with current-session persistence pointers.
docs/plan/ai-maintainer.md- Replace old
TODO.md/tickets/authority language with currenttickets.sh+work-items/operation.
- Replace old
Acceptance criteria
- High-priority stale claims from the docs audit are either corrected or explicitly marked historical/superseded.
- Updated docs consistently describe current Pod metadata vs session-store vs runtime registry responsibilities at a high level.
- Updated docs do not claim
TODO.md/ legacytickets/are the active work-item authority. - Updated docs do not claim
Ctrl-Ris removed; TUI keybindings reflect current behavior sufficiently for users. - No generated report/history document is rewritten as if it were current spec authority.
./tickets.sh doctorandgit diff --checkpass.