EdisonJwa
41d5a4b91b
New controlled documents:
* docs/verification/macos-p0-acceptance.md
15-row human-must checklist for Apple Silicon macOS P0 sign-off.
Targets the SDD-085 CGEventTap backend (now fully live) +
SDD-094..097 audio lifecycle. Auto-test rows pre-filled from the
M1 Mac verification pass: chanora_audio 34 / 0 / 0 (Linux: 32;
macOS delta is the keymap + Send-bound + descriptor-builder
tests). Pre-flight covers the manual framework-wrap +
install_name_tool + ad-hoc codesign step via the new
tools/macos-postbuild.sh. TC-3 walks the Input Monitoring grant
+ descriptor watch transition timing (~1.5 s).
* docs/verification/ios-p0-acceptance.md
12-row human-must checklist for iOS P0 sign-off on a physical
iPhone via the developer's free Apple Personal Team. TC-3
documents the Focused-only PTT capability iOS gives us (no
global event tap analogue exists). TC-8 covers UIBackgroundModes
= audio. TC-9 covers AVAudioSession routing — phone-call
interruption, AirPods route, etc.
docs/governance/document-index.md
Bumped to 0.9.8 with a change-history row covering both new
acceptance documents. No spec items added; the existing SDD-085
(macOS) and SDD-094..097 (audio lifecycle) are what these
documents sign off.
python3 tools/validate_docs.py: clean (pre-existing 35-filename
[FAIL] retained, unchanged).
93 lines
5.8 KiB
Markdown
93 lines
5.8 KiB
Markdown
# Document Index
|
|
|
|
**Document type:** Configuration / Documentation Control
|
|
**Version:** 0.9.8
|
|
**Status:** Baseline Candidate
|
|
**Language:** English
|
|
**Product:** Chanora
|
|
**Repo path:** `docs/governance/document-index.md`
|
|
|
|
---
|
|
|
|
## 1. Purpose
|
|
|
|
This document lists the normalized latest files included in the Chanora repository documentation package.
|
|
|
|
## 2. Current Baseline Candidate Files
|
|
|
|
| File | Status |
|
|
|---|---|
|
|
| `docs/architecture/sad.md` | Baseline Candidate |
|
|
| `docs/architecture/sdd.md` | Baseline Candidate |
|
|
| `docs/architecture/sysdes.md` | Baseline Candidate |
|
|
| `docs/architecture/desktop-ptt-architecture.md` | Baseline Candidate |
|
|
| `docs/governance/baseline-approval-record.md` | Baseline Candidate |
|
|
| `docs/governance/baseline-candidate-validation-report.md` | Baseline Candidate |
|
|
| `docs/governance/decision-impact-assessment.md` | Baseline Candidate |
|
|
| `docs/governance/document-naming-convention.md` | Baseline Candidate |
|
|
| `docs/governance/document-review-report.md` | Baseline Candidate |
|
|
| `docs/governance/git-commit-message-convention.md` | Baseline Candidate |
|
|
| `docs/governance/path-migration-map.md` | Baseline Candidate |
|
|
| `docs/governance/product-decision-register.md` | Baseline Candidate |
|
|
| `docs/governance/repo-format-validation-report.md` | Baseline Candidate |
|
|
| `docs/governance/traceability-matrix.md` | Baseline Candidate |
|
|
| `docs/i18n/localization-architecture.md` | Baseline Candidate |
|
|
| `docs/legal/trademark-and-attribution-review.md` | Baseline Candidate |
|
|
| `docs/privacy/privacy-policy.md` | Baseline Candidate |
|
|
| `docs/references/aspice-swe2-swe3-integration-note.md` | Baseline Candidate |
|
|
| `docs/references/external-references.md` | Baseline Candidate |
|
|
| `docs/release/platform-release-policy.md` | Baseline Candidate |
|
|
| `docs/release/release-readiness-go-nogo-record.md` | Baseline Candidate |
|
|
| `docs/requirements/srs.md` | Baseline Candidate |
|
|
| `docs/requirements/sysrs.md` | Baseline Candidate |
|
|
| `docs/security/dependency-and-supply-chain-report.md` | Baseline Candidate |
|
|
| `docs/security/diagnostic-redaction-audit-report.md` | Baseline Candidate |
|
|
| `docs/security/secure-storage-audit-report.md` | Baseline Candidate |
|
|
| `docs/security/security-privacy-legal-guideline.md` | Baseline Candidate |
|
|
| `docs/security/threat-model.md` | Baseline Candidate |
|
|
| `docs/ui-ux/adaptive-layout-platform-guide.md` | Baseline Candidate |
|
|
| `docs/ui-ux/material3-component-catalog.md` | Baseline Candidate |
|
|
| `docs/ui-ux/material3-design-tokens.md` | Baseline Candidate |
|
|
| `docs/ui-ux/material3-guideline.md` | Baseline Candidate |
|
|
| `docs/verification/swe4-unit-verification-plan.md` | Baseline Candidate |
|
|
| `docs/verification/swe5-software-integration-verification-plan.md` | Baseline Candidate |
|
|
| `docs/verification/swe6-software-verification-plan.md` | Baseline Candidate |
|
|
| `docs/verification/sys4-system-integration-verification-plan.md` | Baseline Candidate |
|
|
| `docs/verification/verification-master-plan.md` | Baseline Candidate |
|
|
|
|
## 3. Core Engineering Hierarchy
|
|
|
|
```text
|
|
SysRS -> SysDes -> SRS -> SAD -> SDD
|
|
```
|
|
|
|
## 4. Verification Work Product Mapping
|
|
|
|
```text
|
|
SDD -> SWE.4
|
|
SAD + SDD -> SWE.5
|
|
SRS -> SWE.6
|
|
SysDes -> SYS.4
|
|
```
|
|
|
|
## 5. Repo File Naming Rules
|
|
|
|
| Rule | Decision |
|
|
|---|---|
|
|
| Product prefix in file names | Not used under `docs/` |
|
|
| Case style | lowercase kebab-case |
|
|
| Version in file name | Not used |
|
|
| Version location | Inside document metadata |
|
|
| Release package version | Used in ZIP/package name |
|
|
|
|
## 6. Change History
|
|
|
|
| Version | Date | Description |
|
|
|---|---|---|
|
|
| 0.9.2 | 2026-05-14 | Converted documentation package to repository-oriented docs folder structure and updated internal filename references. |
|
|
| 0.9.3 | 2026-05-15 | Added `docs/architecture/desktop-ptt-architecture.md` to the controlled document set. |
|
|
| 0.9.5 | 2026-05-15 | Bumped controlled-set version to 0.9.5 for the v1 audio + PTT lifecycle refactor: SysRS-303..304, SysDes-149..151, SRS-204..207, SAD-081..083, SDD-094..097, and two new governance decisions DEC-029 (Flutter global-hotkey packages rejected for PTT) and DEC-030 (Voice Activity Detection deferred to P1). No controlled files added or removed; existing files updated in place under strict layered sourcing. |
|
|
| 0.9.6 | 2026-05-16 | Added DEC-031 (missed-key-up watchdog disabled on P0; redesign deferred to P1) and new controlled document `docs/verification/windows-p0-acceptance.md` carrying the 15-row human-must acceptance plan for the v1.0.0-rc.8 Windows ship. No spec items added; DEC-028 retained as historical context, superseded by DEC-031 for the v1 ship. |
|
|
| 0.9.7 | 2026-05-16 | Added controlled document `docs/verification/linux-p0-acceptance.md` carrying the 15-row human-must acceptance plan for the v1.0.0-rc.8 Linux (GNOME on Wayland) ship. Auto-test sign-off rows filled from the Arch host `100.74.219.114` verification pass: `cargo check --workspace --release` clean, `cargo test --workspace --lib` 78 / 0 / 1, `cargo test -p chanora_audio --test linux_portal_smoke -- --ignored` 1 / 0, `cargo test -p chanora_audio --test ptt_privacy` 1 / 0. No spec items added; the existing SDD-086 GNOME-Wayland portal backend is what this document signs off. |
|
|
| 0.9.8 | 2026-05-16 | Added controlled documents `docs/verification/macos-p0-acceptance.md` (15-row checklist for Apple Silicon macOS, SDD-085 CGEventTap backend now fully live with IOHIDCheckAccess + CGEventTapCreate + per-1.5s permission watcher) and `docs/verification/ios-p0-acceptance.md` (12-row checklist for physical iPhone via the free Apple Personal Team, SDD-094..097 audio lifecycle, AVAudioSession `.playAndRecord/.voiceChat` configured Swift-side in AppDelegate). The macOS PTT backend descriptor advertises L2/L3 only when Input Monitoring is granted, otherwise L0Focused per SRS-198 honest capability advertising. iOS PTT is L0Focused by design (DEC-025 explicitly does not pursue a global PTT analogue on iOS). No new spec items. |
|