Developer documentation index¶
Active developer and maintainer docs. Historical material is listed only via ARCHIVE_INDEX.
Snapshot¶
Topic |
Where |
|---|---|
Packages |
packages.md — extras and the workspaces package. Pins: |
Known issues |
User-facing: known_limitations.md. Maintainer: security_review_2026-08-23.md, test_suite_review_2026-08-12.md. Tracker: GitHub Issues. |
SLOC |
sloc-estimate-2026-09-02.md — measured with |
Code reviews |
reviews/index.md — dated architecture / SLOC / host-OS assessments (evidence, not contracts). |
Phase 0A / 0B programme¶
Doc |
Purpose |
|---|---|
documentation_inventory_1_0.md |
Docs classification matrix |
script_inventory_1_0.md |
Script support-status matrix |
pre_release_roadmap_1_0.md |
0.9.x → 1.0 programme plan |
|
|
Regenerating workflow walkthrough screenshots/GIFs |
|
Schema epoch inventory + transition UX (sign-off before wipe) |
|
1.0 hardening severity rules |
|
Install-profile planning matrix |
|
Docs surface architecture |
|
Manual acceptance suite skeleton |
|
Analysis quality audit template |
|
Generated registry rows ( |
|
Provisional Recommendation / Severity overlay |
|
Performance envelope planning |
|
Trust / privacy / model gate |
|
Release ops / support policy |
|
Read the Docs go-live flip steps |
|
Unfamiliar-user validation protocol |
|
0.9.9 Overview/results presentation polish (post-maintainer, pre-unfamiliar-user) |
|
Post-0.9.9 wave cut as interim 0.9.9.5 (early 1.x + operator UX before unfamiliar-user) |
Orientation¶
Doc |
Purpose |
|---|---|
Mental model and extension points |
|
Install extras and workspace packages |
|
Docs authority model and sync checklist |
|
System shape (non-authoritative for rules) |
|
Dated architecture / SLOC / host-OS assessments (evidence, not contracts) |
|
Import orchestration ADR |
|
Product definition |
|
Contract map (storage, surfaces, run outcomes) |
|
Supported interfaces |
|
Product roadmap (0.9.x → 1.0 → 2.0) |
|
Theme A insights quality (deterministic/hybrid, less noise) |
|
Theme C CCv2 workspaces design (Speaker ID / Corrections) |
|
Theme C invest/narrow/defer decision |
|
Release evidence checklist |
|
stocktake_2026-07-17.md |
Living decision foundation (0.9→1.0) |
analysis_module_backlog_2026-07-17.md |
Module backlog (0.9.x freeze) |
Active engineering¶
Doc |
Purpose |
|---|---|
Config / settings dual-stack architecture |
|
Settings/knobs assessment and hardening backlog |
|
Pipeline layering contracts |
|
Output conventions guide |
|
Overview ZIP / HTML / EPUB export guide |
|
Run outcome developer notes |
|
Analysis-run performance telemetry |
|
Complexity / performance gates |
|
Composition platform |
|
Dashboard Builder workflows |
|
Web block architecture |
|
Dependency / CVE waiver policy |
|
security_review_2026-08-23.md |
Repository-wide security review and prioritized remediation |
BERTopic optional module |
|
emotion_family_contracts_2026-07-18.md |
Emotion-family contracts |
emotion_family_calibration_protocol_2026-07-18.md |
Calibration protocol |
Voice match index gate |
|
Reference-env index gate |
|
wave2_lexicon_linguistics_2026-07-23.md |
Wave 2 lexicon notes |
wave_b13_interaction_graphs_2026-07-23.md |
Wave B13 interaction graphs |
wave_b16_keyphrases_2026-07-24.md |
Wave B16 keyphrases |
GUI acceptance residual checklist |
|
Install verification matrix |
|
Docker efficiency baseline |
Tests¶
Doc |
Purpose |
|---|---|
tests/README.md |
How to run tests |
test_suite_review_2026-08-12.md |
Living suite review (metrics, CI gaps, P0–P2 backlog) |
tests/contracts/README.md |
Contract tests |
tests/quarantine/README.md |
Quarantined tests |
Script archive (executable)¶
Non-production scripts: archive/README.md.
Documentation archive¶
archive/ARCHIVE_INDEX.md