- Move ASPICE docs to chanoraapp/docs submodule at docs/ - Move development docs to dev-docs/ (superpowers, offline-knowledge, impl-mapping) - Add AGENTS.md with project conventions for AI agents - Add impl-mapping.md (SAD component → source file mapping) - Archive completed plans to dev-docs/superpowers/plans/_archived/ - Remove AGENTS.md from .gitignore (now tracked)
10 KiB
10 KiB
Documentation Out-of-Date Analysis
Generated: 2026-06-13
Workspace version: 0.2.0-beta.1
Latest commit: dd6e80f (2026-06-13)
Summary
- Total docs checked: 64
- Outdated docs: 12
- Stale version refs: 5
- Undocumented recent changes: 8
- Stale date refs: 15+
Stale Version References
| File | Line | Version Referenced | Current Version | Drift |
|---|---|---|---|---|
docs/sysdes.md |
6 | 0.9.8 | N/A (doc version) | Last updated 2026-05-14, 30 days stale |
docs/srs.md |
7 | 0.9.9 | N/A (doc version) | Last updated 2026-05-18, 26 days stale |
docs/sysrs.md |
5 | 0.9.11 | N/A (doc version) | Last updated 2026-06-07, 6 days stale |
docs/material3-guideline.md |
~4 | 0.9.2 | N/A (doc version) | Last updated 2026-05-14, 30 days stale |
tools/windows-smoke.md |
6 | product/scaffold-v0 branch |
main |
Default branch changed per CHANGELOG |
Stale Date References
| File | Date | Age | Issue |
|---|---|---|---|
docs/implementation-status-2026-05-28.md |
2026-05-28 | 16 days | Pre-dates DV baseline (2026-05-29) and 8 major feature PRs |
docs/architecture/sad.md |
2026-05-29 | 15 days | Missing file transfer, poke notifications, desktop VAD features |
docs/architecture/sdd.md |
2026-05-29 | 15 days | Missing file transfer, poke notifications, desktop VAD features |
docs/verification/verification-master-plan.md |
2026-05-29 | 15 days | Missing file transfer and poke notification verification |
docs/verification/swe4-unit-verification-plan.md |
2026-05-29 | 15 days | Missing new test coverage for file transfer |
docs/verification/swe5-software-integration-verification-plan.md |
2026-05-29 | 15 days | Missing file transfer integration verification |
docs/verification/swe6-software-verification-plan.md |
2026-05-29 | 15 days | Missing file transfer software verification |
docs/verification/sys4-system-integration-verification-plan.md |
2026-05-29 | 15 days | Missing file transfer system verification |
docs/governance/product-decision-register.md |
2026-05-29 | 15 days | Missing file-transfer-related decisions |
docs/governance/document-index.md |
2026-05-29 | 15 days | Missing file-transfer-design.md, file-transfer-research.md, file-transfer-implementation-plan.md |
docs/security/security-privacy-legal-guideline.md |
2026-05-29 | 15 days | Missing file transfer security considerations |
docs/security/threat-model.md |
2026-05-29 | 15 days | Missing file transfer threat analysis |
docs/i18n/localization-architecture.md |
2026-05-29 | 15 days | Missing poke notification l10n strings |
docs/legal/trademark-and-attribution-review.md |
2026-05-29 | 15 days | Missing cacache license review |
docs/privacy/privacy-policy.md |
2026-05-29 | 15 days | Missing file transfer data handling |
Undocumented Recent Changes
| Change | Date | Expected Doc | Status |
|---|---|---|---|
| File transfer system (avatar/icon download with cacache) | 2026-06-10 | README.md, SAD, SDD, CHANGELOG | Not in README crate list, not in CHANGELOG |
| Poke notifications (local notifications, settings, bridge) | 2026-06-08 | SAD, SDD, CHANGELOG | Not in CHANGELOG |
| Desktop Silero ONNX VAD + Windows PTT modernization | 2026-06-09 | SAD, SDD, CHANGELOG | Not in CHANGELOG |
| iOS RemoteIO+WebRTC APM path removal | 2026-06-10 | SAD, SDD | Not documented |
| SonoraExperimental bridge API removal | 2026-06-10 | SAD, SDD, bridge docs | Not documented |
| iOS AVAudioSession activation fix | 2026-06-10 | Platform docs | Not documented |
| iOS Debug build unblocking + FRB regeneration | 2026-06-10 | Build docs | Not documented |
| poke-without-message design | 2026-06-09 | Design docs | Committed but not indexed |
Feature Drift
Documented but No Longer in Code
| Feature | Doc File | Last Seen In Code |
|---|---|---|
SonoraExperimental bridge API |
docs/architecture/sdd.md (implied) |
Removed 2026-06-10 (commit 2b28549) |
iOS ios_raw_unit.rs |
docs/implementation-status-2026-05-28.md:33 |
Removed 2026-06-10 (commit 3f9ea4f) |
SnapshotChanged event variant |
CHANGELOG v0.3.0 | Removed end-to-end |
| Timer-based snapshot polling | CHANGELOG v0.2.0-beta.1 | Replaced by event-driven UI |
In Code but Not Documented
| Feature | Code Location | Expected Doc |
|---|---|---|
chanora_cache crate (cacache-backed blob store) |
crates/chanora_cache/ |
README.md crate list, SAD, SDD |
| File transfer protocol support | crates/chanora_protocol/ |
SAD, SDD, CHANGELOG |
| Poke notification service | apps/chanora_flutter/lib/services/ |
SAD, SDD, CHANGELOG |
| Poke notification settings UI | apps/chanora_flutter/lib/widgets/ |
SAD, SDD |
| Desktop Silero ONNX VAD | crates/chanora_audio/src/vad/silero_onnx.rs |
SAD, SDD |
| Windows PTT modernization | crates/chanora_audio/src/ptt_backends/windows.rs |
SAD, SDD |
poke_limiter.rs |
crates/chanora_protocol/src/poke_limiter.rs |
SAD, SDD |
| Local notification plugin integration | apps/chanora_flutter/ |
SAD, SDD |
Per-File Out-of-Date Assessment
README.md
- Last meaningful update: Unknown (no date in file)
- Stale sections:
- Crate list (line 242-249): Missing
chanora_cacheandchanora_resolvercrates - Repository layout (line 233-249): Missing
chanora_cache,chanora_resolver,chanora_prefetch - Status section (line 16-23): References "v0.9.x document set" — no specific date
- Development section (line 398-409): Missing
justcommands (justfile exists)
- Crate list (line 242-249): Missing
- Missing recent changes: File transfer system, poke notifications, desktop VAD
docs/sysdes.md
- Version: 0.9.8
- Last change record: 2026-05-14
- Stale sections: All — 30 days without update
- Missing: File transfer system element (SE-20?), poke notification interface (IF-015?)
docs/srs.md
- Version: 0.9.9
- Last change record: 2026-05-18
- Stale sections: All — 26 days without update
- Missing: File transfer SRS requirements, poke notification SRS requirements, desktop VAD SRS requirements
docs/sysrs.md
- Version: 0.9.11
- Last change record: 2026-06-07
- Stale sections: Mostly current but missing file transfer and poke notification requirements
docs/architecture/sad.md
- Date: 2026-05-29
- Stale sections:
- Component architecture table (line 39-50): Missing
chanora_cachecomponent - Missing file transfer architecture
- Missing poke notification architecture
- Missing desktop VAD architecture
- Component architecture table (line 39-50): Missing
- Missing recent changes: All PRs from 2026-06-07 through 2026-06-13
docs/architecture/sdd.md
- Date: 2026-05-29
- Stale sections:
- Module catalogue (line 15-31): Missing file transfer module, poke notification module
- Missing
chanora_cachemodule (SDD-MOD-016?) - Missing
poke_limitermodule
- Missing recent changes: All PRs from 2026-06-07 through 2026-06-13
docs/implementation-status-2026-05-28.md
- Date: 2026-05-28 — 16 days old
- Stale sections:
- "Done" table: Missing file transfer, poke notifications, desktop VAD, iOS fixes
- "Partial / Scaffold Only":
chanora_cachewas scaffold, now implemented - "Not Done (P0 blockers)": iOS
AVAudioSession.Mode.voiceChat— now implemented (commit89bbfa1) - Android target compilation: Still blocked per DEC-034
- Agent spec docs reference (line 140): States docs are "deleted" — stale cleanup note
- Recommendation: Update to reflect current state or create new status doc
docs/governance/product-decision-register.md
- Date: 2026-05-29
- Note: DEC-033 and DEC-034 are present (lines 20-21). Missing decisions:
- File transfer architecture decision
- Poke notification feature decision
docs/governance/document-index.md
- Date: 2026-05-29
- Missing documents:
docs/architecture/file-transfer-design.mddocs/architecture/file-transfer-research.mddocs/architecture/file-transfer-implementation-plan.mddocs/superpowers/specs/2026-06-09-poke-without-message-design.md
docs/security/license-inventory.md
- Status: Refreshed 2026-06-09 (commit
b841d3f) - Issue: May be missing
cacachedependency license if not in Cargo.lock at refresh time
docs/material3-guideline.md
- Version: 0.9.2
- Last change record: 2026-05-14
- Status: 30 days stale, but Material 3 design may not have changed
tools/windows-smoke.md
- Stale reference: Line 6 references
product/scaffold-v0branch - Current default:
mainper CHANGELOG v0.3.0
docs/verification/*.md (all 5 files)
- Date: All dated 2026-05-29
- Missing: File transfer verification, poke notification verification, desktop VAD verification
Recommendations
Critical (blocks DV/release)
- Update
docs/implementation-status-2026-05-28.md— 16 days stale, missing 8 major PRs, iOS voiceChat now implemented - Update
docs/governance/product-decision-register.md— Missing file transfer and poke notification decisions - Update
docs/governance/document-index.md— Missing 3 file-transfer docs
High Priority (DV completeness)
- Update
docs/architecture/sad.md— Missing file transfer, poke notifications, desktop VAD, chanora_cache component - Update
docs/architecture/sdd.md— Missing file transfer, poke notifications, desktop VAD modules - Update
docs/sysdes.md— 30 days stale, missing file transfer system elements - Update
docs/srs.md— 26 days stale, missing file transfer and poke notification requirements - Update CHANGELOG.md — Missing v0.3.0+ changes (file transfer, poke notifications, desktop VAD, iOS fixes)
Medium Priority (accuracy)
- Update README.md — Missing
chanora_cacheandchanora_resolverin crate list - Update
tools/windows-smoke.md— Fix stale branch reference - Update verification plans — Add file transfer and poke notification verification
- Update security docs — Add file transfer threat analysis
Low Priority (cleanup)
- Align document versions — SysDes (0.9.8), SysRS (0.9.11), Material3 (0.9.2) have different version numbers
- Clean up path record files —
docs/architecture/sysdes.md,docs/requirements/sysrs.md,docs/requirements/srs.md,docs/ui-ux/material3-guideline.mdare stubs pointing to canonical files