Files
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
..

Chanora Offline Knowledge Library

Generated: 2026-06-13
Branch: docs/offline-knowledge-library-2026-06-13
Purpose: Comprehensive offline reference for the Chanora project, its dependencies, and related ecosystem.


Contents

Project Analysis

Document Description Status
function-inventory.md Complete public API inventory for all 10 Rust crates + 56 Dart files. Includes dead code analysis. Reviewed
coverage-analysis.md Test coverage (312 Rust tests, 221 Dart tests) and documentation coverage gaps. Reviewed, corrected
doc-quality-analysis.md Duplicated content, useless content, and broken references in docs/. Reviewed, corrected
link-coverage-report.md All internal/external links validated. 2 broken LICENSE links, 5 broken doc-path refs. Reviewed, corrected
docs-code-mismatch.md 17 doc-code mismatches found (2 critical, 4 major, 11 minor). Reviewed, corrected
docs-out-of-date.md 12 outdated docs, 8 undocumented recent changes since DV baseline. Reviewed, corrected
docs-link-not-covered.md 2 broken links, 9 missing targets, 18 orphaned docs. Reviewed, corrected

External Projects

Document Description Status
external/teaspeak-overview.md TeaSpeak voice server - architecture, protocol, build system. Reviewed
external/respeak-overview.md ReSpeak org - tsclientlib, tsproto, crypto, Chanora integration. Reviewed
external/yatqa-en.md yat.qa TeamSpeak admin tool (English). Reviewed
external/yatqa-de.md yat.qa TeamSpeak admin tool (German/Deutsch). Reviewed

Review Reports

Document Description
reviews/coverage-analysis-review.md Cross-validation of coverage analysis
reviews/doc-quality-review.md Cross-validation of doc quality analysis
reviews/link-coverage-review.md Cross-validation of link coverage
reviews/external-docs-review.md Cross-validation of external project docs
reviews/docs-code-mismatch-review.md Cross-validation of mismatch analysis
reviews/docs-out-of-date-review.md Cross-validation of out-of-date analysis
reviews/docs-link-not-covered-review.md Cross-validation of link-not-covered analysis
reviews/function-inventory-review.md Cross-validation of function inventory
reviews/coverage-docquality-review.md Second-pass review of coverage + doc quality
reviews/mismatch-outofdate-review.md Second-pass review of mismatch + out-of-date
reviews/link-reports-review.md Second-pass review of link reports
reviews/external-index-review.md Second-pass review of external docs + index

Key Findings Summary

Test Coverage

  • Rust: 312 inline tests + 5 integration tests across 8/10 crates
  • Dart: 221 tests (widgets: 58%, services: 90%)
  • Untested crates: chanora_bridge, chanora_cache, chanora_prefetch

Documentation Gaps

  • No architecture docs for: audio engine, FFI bridge, protocol layer, state machine, cache, prefetch, diagnostics
  • 15 TODO/FIXME items catalogued across codebase

Dead/Useless Code

  • No true dead code found (platform-gated items are intentional)
  • 1 malformed markdown in docs/sysdes.md
  • 2 missing LICENSE files (LICENSE-APACHE, LICENSE-MIT)

Duplicated Content

  • Lifecycle chain repeated in 6+ files
  • Git commit examples in 3 files
  • Security doc list in 2 files

External Dependencies

  • ReSpeak/tsclientlib: Chanora patches tsproto-types for P-256 coordinate padding
  • TeaSpeak: Compatible voice server, C++20 + Electron architecture
  • yat.qa: TeamSpeak admin tool, v3.9.9b, English + German docs