trent_larson/daily-notification-plugin
4
0
Fork 0
Code Issues Pull Requests 2 Projects Releases Wiki Activity

[ALARM-DOCS] fix(docs): remove duplicate status matrix and fix cross-references

Browse Source 
Remove duplicate status matrix from Section 3.3 and consolidate to Section 11
as single source of truth. Fix all section number references throughout
documentation.

Changes:
- Remove duplicate status matrix table from Section 3.3
- Update all references from "Section 3.3" and "Section 10" to "Section 11"
- Fix phase directive paths to use consistent ../ prefix format
- Fix P1 path typo (missing "directive" in filename)
- Update Doc C status in matrix to reflect completion
- Remove duplicate text in Doc B baseline scenarios
- Remove self-referencing links in Doc B

All status matrix references now point to Section 11, eliminating confusion
about which matrix is authoritative.
This commit is contained in:
Matthew Raymer
2025-11-27 07:34:47 +00:00
parent 35babb3126
commit bd842c6ef8
2 changed files with 13 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/alarms/000-UNIFIED-ALARM-DIRECTIVE.md
View File

@@ -50,9 +50,9 @@ Unify all existing alarm/notification documents into a **coherent, layered syste
* `plugin-requirements-implementation.md` – Plugin behavior rules & guarantees
* `android-implementation-directive.md` – Umbrella Android implementation overview (app launch recovery, missed alarms, force stop, boot)
* Phase directives (normative):
* `android-implementation-directive-phase1.md` – Cold start recovery (minimal viable)
* `android-implementation-directive-phase2.md` – Force stop detection & recovery
* `android-implementation-directive-phase3.md` – Boot receiver missed alarm handling
* `../android-implementation-directive-phase1.md` – Cold start recovery (minimal viable)
* `../android-implementation-directive-phase2.md` – Force stop detection & recovery
* `../android-implementation-directive-phase3.md` – Boot receiver missed alarm handling
### 1.4 Improvement Directive
@@ -151,18 +151,7 @@ Already exist; this directive standardizes their role:
### 3.3 Status Matrix
Add this table to the end of *this* directive and keep it updated:
| Doc | Path | Role | Drafted? | Cleaned? | In Use? |
| --- | ------------------------------------- | ----------------- | -------- | -------- | ------- |
| A | `01-platform-capability-reference.md` | Platform facts | ☐ | ☐ | ☐ |
| B | `02-plugin-behavior-exploration.md` | Exploration | ☐ | ☐ | ☐ |
| C | `03-plugin-requirements.md` | Requirements | ☐ | ☐ | ☐ |
| P1 | `android-implementation-phase1.md` | Impl – Cold start | ✅ | ☐ | ☐ |
| P2 | `android-implementation-phase2.md` | Impl – Force stop | ✅ | ☐ | ☐ |
| P3 | `android-implementation-phase3.md` | Impl – Boot | ✅ | ☐ | ☐ |
(You can edit this directly in git as you go.)
**Status matrix is maintained in Section 11** (see below). This section is kept for historical reference only.
---
@@ -233,7 +222,7 @@ This is the **concrete to-do list** that satisfies:
1. At the top of Docs A, B, C, and each Phase doc, add:
* `Version`, `Last Updated`, `Sync'd with Plugin vX.Y.Z`
2. Maintain the status matrix (Section 3.3) as the **single source of truth** for doc maturity
2. Maintain the status matrix (Section 11) as the **single source of truth** for doc maturity
3. When a Phase is fully implemented and deployed:
* Mark "In Use?" = ✅
* Add link to code tags/commit hash
@@ -284,7 +273,7 @@ This directive is complete **ONLY** when:
* Banner: "⚠️ **DEPRECATED**: Superseded by [000-UNIFIED-ALARM-DIRECTIVE](./000-UNIFIED-ALARM-DIRECTIVE.md)"
* Link to replacement document
6. **Status matrix fields are no longer empty** (Section 10)
6. **Status matrix fields are no longer empty** (Section 11)
* All docs marked as Drafted at minimum
---
@@ -428,7 +417,7 @@ When a conflict is found:
Any change to Docs A–C requires:
1. **Update version header** in the document
2. **Update status matrix** (Section 10) in this directive
2. **Update status matrix** (Section 11) in this directive
3. **Commit message tag**: `[ALARM-DOCS]` prefix
4. **Notification in CHANGELOG** if JS/TS-visible behavior changes
@@ -451,10 +440,10 @@ Any change to Docs A–C requires:
| --- | ------------------------------------- | ----------------- | -------- | -------- | ------- | ---------------------------------------- |
| A | `01-platform-capability-reference.md` | Platform facts | ✅ | ✅ | ✅ | Created, merged from platform docs, canonical rule added |
| B | `02-plugin-behavior-exploration.md` | Exploration | ✅ | ✅ | ☐ | Converted to executable test harness |
| C | `03-plugin-requirements.md` | Requirements | ✅ | ⚠️ | ⚠️ | Enhanced with guarantees matrix, JS/TS contract, traceability - **in compliance** |
| P1 | `../android-implementation-phase1.md` | Impl – Cold start | ✅ | ✅ | ☐ | Aligned with Doc C |
| P2 | `../android-implementation-phase2.md` | Impl – Force stop | ✅ | ✅ | ☐ | Aligned with Doc C |
| P3 | `../android-implementation-phase3.md` | Impl – Boot | ✅ | ✅ | ☐ | Aligned with Doc C |
| C | `03-plugin-requirements.md` | Requirements | ✅ | ✅ | ✅ | Enhanced with guarantees matrix, JS/TS contract, traceability - **complete and in compliance** |
| P1 | `../android-implementation-directive-phase1.md` | Impl – Cold start | ✅ | ✅ | ☐ | Aligned with Doc C |
| P2 | `../android-implementation-directive-phase2.md` | Impl – Force stop | ✅ | ✅ | ☐ | Aligned with Doc C |
| P3 | `../android-implementation-directive-phase3.md` | Impl – Boot | ✅ | ✅ | ☐ | Aligned with Doc C |
**Doc C Compliance Milestone**: Doc C is considered complete **ONLY** when:
- ✅ Cross-platform guarantees matrix present

4
docs/alarms/02-plugin-behavior-exploration.md
View File

@@ -256,8 +256,8 @@ This document provides an **executable test harness** for exploring and document
2. ✅ **OS low-RAM kill** - Test 3 (Android)
3. ✅ **Reboot** - Test 4 (Android), Test 3 (iOS)
4. ✅ **Force stop** - Test 5 (Android only)
5. ✅ **Cold start** - See [Test 4 Step 5](./02-plugin-behavior-exploration.md#test-4-device-reboot) (Android), Test 4 (iOS)
6. ✅ **Notification-tap resume** - See [Recovery Points §1.4](./02-plugin-behavior-exploration.md#14-recovery-points-investigation) (Both)
5. ✅ **Cold start** - Test 4 Step 5 (Android), Test 4 (iOS)
6. ✅ **Notification-tap resume** - Recovery Points §1.4 (Both)
---