edison/chanora
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d97118bb6a321eb7dec643e8a675711fe78dfbdd
chanora/dev-docs/offline-knowledge/reviews/docs-out-of-date-review.md
T
Edison Jwa bba6273af7 refactor: restructure docs as submodule, add dev-docs/ and AGENTS.md 
- 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)
2026-06-13 03:32:33 +09:00

8.4 KiB
Raw Blame History

Review: docs-out-of-date.md

Reviewer: opencode Date: 2026-06-13 Target: docs/offline-knowledge/docs-out-of-date.md

Overall Assessment

The document is mostly accurate with 2 factual errors and a few minor issues. The core analysis — stale version refs, undocumented changes, and outdated docs — is well-supported by evidence. However, two claims about the product-decision-register and document-index are incorrect.

1. Stale Version References — Spot-Check 3

✅ docs/sysdes.md line 6: Version 0.9.8

Verdict: Accurate. File confirms **Version:** 0.9.8 at line 6. Last change record is 2026-05-14 (30 days stale as of generation date).

✅ docs/srs.md line 7: Version 0.9.9

Verdict: Accurate. File confirms **Version:** 0.9.9 at line 6 (not line 7 as claimed — off by one). Last change record is 2026-05-18 (26 days stale).

✅ docs/material3-guideline.md ~line 4: Version 0.9.2

Verdict: Accurate. File confirms **Version:** 0.9.2 at line 4. Last change record is 2026-05-14 (30 days stale). The document notes Material 3 design may not have changed, which is fair.

Summary: All 3 stale version refs verified. Minor line-number error on srs.md (says line 7, actual line 6).

2. Undocumented Changes — Spot-Check 3

✅ File transfer system (2026-06-10)

Verdict: Accurate.

  • Commit aa796d7 confirms: feat: file transfer system (avatar/icon download with cacache) (#40)
  • chanora_cache crate exists at crates/chanora_cache/
  • file_transfer.rs exists at core/chanora_core/src/file_transfer.rs
  • Design docs exist: docs/architecture/file-transfer-design.md, file-transfer-research.md, file-transfer-implementation-plan.md
  • CHANGELOG.md has no mention of file transfer, cacache, or chanora_cache. Confirmed undocumented in CHANGELOG.
  • README.md crate list (lines 242-249) does not include chanora_cache. Confirmed undocumented in README.

✅ Poke notifications (2026-06-08)

Verdict: Accurate.

  • Commits 3ef540a through b565663 confirm: poke notification service, settings dialog, preferences, l10n, bridge integration
  • poke_limiter.rs exists at crates/chanora_protocol/src/poke_limiter.rs
  • poke_notification_service.dart exists at apps/chanora_flutter/lib/services/
  • poke_notification_settings.dart exists at apps/chanora_flutter/lib/widgets/
  • CHANGELOG.md has no mention of poke notifications. Confirmed undocumented in CHANGELOG.

✅ Desktop Silero ONNX VAD + Windows PTT modernization (2026-06-09)

Verdict: Accurate.

  • Commit 2f6d45f confirms: feat(audio): desktop Silero ONNX VAD + Windows PTT modernization + MSVC CRT build fix (#37)
  • silero_onnx.rs exists at crates/chanora_audio/src/vad/silero_onnx.rs
  • CHANGELOG mentions Apple CoreML Silero VAD and Linux ONNX Runtime VAD, but not the desktop Silero ONNX VAD or Windows PTT modernization from this commit. Confirmed undocumented in CHANGELOG.

Summary: All 3 undocumented changes verified. The CHANGELOG is missing these entries.

3. "12 Outdated Docs" Claim — Spot-Check 3

✅ docs/architecture/sad.md (dated 2026-05-29)

Verdict: Confirmed outdated.

  • Component architecture table (lines 39-52) lists 12 components but does not include chanora_cache.
  • No mention of file transfer architecture, poke notification architecture, or the new desktop Silero ONNX VAD.
  • SAD does mention chanora_resolver and chanora_prefetch (lines 51-52), so the resolver/prefetch are current — but chanora_cache is a clear omission.

✅ docs/architecture/sdd.md (dated 2026-05-29)

Verdict: Confirmed outdated.

  • Module catalogue (lines 15-31) lists 15 modules (SDD-MOD-001 through SDD-MOD-015).
  • No module for file transfer (should be ~SDD-MOD-016).
  • No module for poke notifications (should be ~SDD-MOD-017).
  • No module for chanora_cache (should be covered by file transfer module or standalone).
  • No module for poke_limiter.

✅ docs/governance/document-index.md (dated 2026-05-29)

Verdict: Confirmed outdated.

  • Does not list docs/architecture/file-transfer-design.md
  • Does not list docs/architecture/file-transfer-research.md
  • Does not list docs/architecture/file-transfer-implementation-plan.md
  • Does not list docs/superpowers/specs/2026-06-09-poke-without-message-design.md
  • Does not list docs/security/license-inventory.md
  • Does list docs/governance/maintainability-review-2026-06-08.md (line 29) — see error #2 below.

Summary: All 3 spot-checked docs confirmed outdated. The "12 outdated docs" claim is plausible.

4. Were Any Outdated Docs Missed?

Potentially missed:

  1. docs/release/dv-waiver-register.md — References docs/implementation-status-2026-05-28.md (line 17) and notes that iOS AVAudioSession.Mode.voiceChat status needs updated validation. This doc itself may need updating now that voiceChat is implemented (commit 89bbfa1).

  2. docs/governance/decision-impact-assessment.md — References VAD platform scope. May need updating for desktop Silero ONNX VAD enablement.

  3. docs/security/license-inventory.md — The document itself notes it was refreshed 2026-06-09 (commit b841d3f), but the analysis flags it may be missing cacache dependency. The cacache crate IS in Cargo.lock (confirmed), so if the refresh was done against the current lock file, it should be covered. This needs manual verification but is not clearly outdated.

  4. docs/governance/maintainability-review-2026-06-08.md — Already listed in document-index, but its content may be missing references to file transfer and poke notification features added after its date.

Not missed (already covered):

The document already covers the verification plans, security docs, privacy docs, i18n docs, and legal docs. These are all confirmed outdated (grep found no file transfer or poke mentions in any of them).

5. Factual Errors Found

❌ Error 1: DEC-033 and DEC-034 claimed missing from product-decision-register

Claim (line 36-37, 137-138): docs/governance/product-decision-register.md is "Missing DEC-033 (macOS VPIO ducking) and DEC-034 (Android runtime gate)"

Reality: Both decisions are present in the file:

  • Line 20: DEC-033 macOS VPIO ducking configuration | Accepted | ...
  • Line 21: DEC-034 Android runtime verification gate | Active tracking | ...

Impact: This error undermines the "Critical" recommendation #2 to update the product-decision-register. The register already contains these decisions.

❌ Error 2: maintainability-review claimed "listed but dated wrong"

Claim (line 149): docs/governance/maintainability-review-2026-06-08.md is "listed but dated wrong"

Reality: The document-index lists it at line 29 as docs/governance/maintainability-review-2026-06-08.md with status "Working-branch maintainability and fail-safe review". The filename contains the date 2026-06-08, which matches the document's actual date. There is no dating error.

Impact: Minor. The document may still be outdated (missing file transfer/poke content), but the specific "dated wrong" claim is incorrect.

6. Minor Issues

  1. Line number off-by-one: docs/srs.md version is at line 6, not line 7 as claimed.
  2. SAD component table scope: The SAD does list chanora_resolver and chanora_prefetch (lines 51-52), which means only chanora_cache is missing from the component table — not "Missing chanora_cache component" as a standalone issue. The SAD also mentions VAD (line 126, 162), so the "Missing desktop VAD architecture" claim needs nuance — VAD is mentioned but the specific desktop Silero ONNX VAD implementation is not.
  3. Feature drift section accuracy: The "Documented but No Longer in Code" section correctly identifies SonoraExperimental removal (commit 2b28549) and ios_raw_unit.rs removal (commit 3f9ea4f). The SnapshotChanged and timer-based polling claims are supported by CHANGELOG v0.3.0 entries.

Summary Table

Check Result
Stale version refs (3 checked) ✅ All 3 accurate (1 minor line-number error)
Undocumented changes (3 checked) ✅ All 3 accurate
"12 outdated docs" (3 spot-checked) ✅ All 3 confirmed outdated
Missed outdated docs 2-3 additional docs may be outdated
Factual errors ❌ 2 errors found (DEC-033/034 claim, maintainability-review date claim)

Recommendation: Correct the 2 factual errors before using this document for DV planning. The core analysis is sound.

Reference in New Issue View Git Blame Copy Permalink