- 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)
73 lines
3.1 KiB
Markdown
73 lines
3.1 KiB
Markdown
# Link Coverage Report — Review
|
||
|
||
**Reviewed:** 2026-06-13
|
||
**Source:** `docs/offline-knowledge/link-coverage-report.md`
|
||
|
||
## Verdict: Largely Accurate
|
||
|
||
The report is thorough and all major claims have been verified. One minor counting discrepancy found.
|
||
|
||
---
|
||
|
||
## 1. Broken Internal Links (LICENSE-APACHE, LICENSE-MIT)
|
||
|
||
**CLAIM:** `LICENSE-APACHE` and `LICENSE-MIT` do not exist at repo root.
|
||
|
||
**VERIFIED:** Correct. `ls /Users/edison/dev/chanora/LICENSE*` returns no matches. `NOTICE` (line 444) does exist.
|
||
|
||
The report also correctly identifies 4 additional references to these missing files in `docs/security/license-inventory.md` (lines 9–10) and `docs/security/flutter-license-inventory.md` (lines 11–12) using relative paths `../../LICENSE-APACHE` and `../../LICENSE-MIT`.
|
||
|
||
---
|
||
|
||
## 2. Broken Inline Doc-Path References
|
||
|
||
**CLAIM:** 5 references to `docs/chanora_*.md` files in `docs/sysrs.md` lines 126–130 are broken.
|
||
|
||
**VERIFIED:** Correct. All 5 files confirmed missing:
|
||
- `docs/chanora_SysDes.md` — MISSING
|
||
- `docs/chanora_SRS.md` — MISSING
|
||
- `docs/chanora_SAD.md` — MISSING
|
||
- `docs/chanora_SDD.md` — MISSING
|
||
- `docs/chanora_Verification.md` — MISSING
|
||
|
||
The report's assessment that these are low-severity (aspirational table entries, not navigable links) is accurate.
|
||
|
||
---
|
||
|
||
## 3. Spot-Check of Claimed Valid Links
|
||
|
||
10 links verified — all exist:
|
||
|
||
| # | File | Target | Status |
|
||
|---|------|--------|--------|
|
||
| 1 | README.md:130 | `docs/architecture/desktop-ptt-architecture.md` | EXISTS |
|
||
| 2 | README.md:436 | `docs/governance/product-decision-register.md` | EXISTS |
|
||
| 3 | README.md:444 | `NOTICE` | EXISTS |
|
||
| 4 | `docs/superpowers/specs/2026-06-05-adaptive-3-panel-layout-design.md:266` | `../ui-ux/adaptive-layout-platform-guide.md` | EXISTS |
|
||
| 5 | `docs/governance/git-commit-message-convention.md` (from CONTRIBUTING.md:25) | EXISTS |
|
||
| 6 | `docs/security/threat-model.md` | EXISTS |
|
||
| 7 | `docs/security/secure-storage-audit-report.md` | EXISTS |
|
||
| 8 | `docs/privacy/privacy-policy.md` | EXISTS |
|
||
| 9 | `docs/requirements/sysrs.md` | EXISTS |
|
||
| 10 | `docs/architecture/sysdes.md` | EXISTS |
|
||
|
||
---
|
||
|
||
## 4. Missed Links
|
||
|
||
**No internal markdown links were missed.** A repo-wide grep for `[text](path)` patterns in `.md` files (excluding `http` URLs and the report itself) returns exactly 10 links — all accounted for in the report.
|
||
|
||
---
|
||
|
||
## 5. Discrepancy Found
|
||
|
||
**Summary count mismatch:** The report summary states "Valid internal links: 12" but the "Valid Internal Links" table (§2) lists only 4 entries. The remaining 8 may be counted from the cross-references section or the "Also affected" table, but the categorization is unclear. This does not affect the report's accuracy on individual link status.
|
||
|
||
---
|
||
|
||
## 6. Additional Observations
|
||
|
||
- The report correctly identifies path-record stubs (`docs/requirements/sysrs.md` → `docs/sysrs.md`, etc.) as intentional navigation aids, not broken links.
|
||
- The `snapshot_state_mapper.dart` directory mismatch (widgets/ vs services/) is a genuine doc inaccuracy worth noting.
|
||
- External link count (48) was not verified — these are URLs requiring HTTP checks.
|