diff options
| author | Christian Cleberg <[email protected]> | 2026-07-25 11:39:55 -0500 |
|---|---|---|
| committer | Christian Cleberg <[email protected]> | 2026-07-25 11:40:57 -0500 |
| commit | b824dae8ea16d20d75136687a7c59bc7b01afe27 (patch) | |
| tree | 9a52ade1a5e1ada5d3ab2515572bb49a286782af /README.md | |
| parent | cc1cb343b19b662ef59f9700702ed285e4591029 (diff) | |
| download | domain-dig-b824dae8ea16d20d75136687a7c59bc7b01afe27.tar.gz domain-dig-b824dae8ea16d20d75136687a7c59bc7b01afe27.tar.bz2 domain-dig-b824dae8ea16d20d75136687a7c59bc7b01afe27.zip | |
docs: polish repo documentation after the v5.0.0 work
Brings the docs in line with the shipped v5.0.0 state and fixes staleness that
accumulated across the release.
- README: add a Tests section documenting the DomainDigTests unit net and that
the scheme's test action runs both it and the accessibility audit; reword the
roadmap pointer (v5.0.0 shipped, no longer "planned"); align the contact
address to [email protected] (was cleberg.net, inconsistent with SECURITY.md).
- ARCHITECTURE: drop the stale "v4.4.1" from the title; note DomainReportExporter
also renders Markdown and PDF; describe the DomainViewModel concern extensions
and the ContentView split (SettingsViews / ResultSectionViews); record that
v5.0.0 stabilized the Local API contract with links to local-api.md and
data-migration.md; add a Testing section covering both test targets.
- SECURITY: bump the supported-versions table from 4.x to 5.x.
ACCESSIBILITY.md, local-api.md, and data-migration.md were already current and
are unchanged. Docs-only; no code changes.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 12 insertions, 2 deletions
@@ -53,6 +53,16 @@ xcodebuild -project DomainDig.xcodeproj -scheme DomainDig -destination 'platform The app and local API share the canonical report pipeline through `DomainInspectionService`, `DomainReportBuilder`, and `DomainReportExporter`. The Local API's endpoints, response envelope, and `v1` compatibility policy are documented in [Docs/local-api.md](Docs/local-api.md). How the on-device store evolves across app versions is documented in [Docs/data-migration.md](Docs/data-migration.md). +### Tests + +Unit coverage of the deterministic core — `DomainReportBuilder`, `DomainReportExporter`, `DiffService`, `DomainDataPortabilityService` (merge/replace dedup), the migration runner, and the Local API contract — lives in the `DomainDigTests` target: + +```sh +xcodebuild test -project DomainDig.xcodeproj -scheme DomainDig -destination 'platform=iOS Simulator,name=iPhone 16' -only-testing:DomainDigTests +``` + +The `DomainDig` scheme's test action runs both `DomainDigTests` and the `DomainDigUITests` accessibility audit, so a plain `xcodebuild test` (and CI) exercises both. + ### Accessibility Audit `DomainDigUITests` runs `performAccessibilityAudit()` over every primary screen, @@ -79,7 +89,7 @@ between this script and CI. ## Release Planning -See `RELEASE_ROADMAP.md` for the semver release plan from `v4.4.1` through the planned `v5.0.0` stabilization milestone. +See `RELEASE_ROADMAP.md` for the semver release history from `v4.4.1` through the `v5.0.0` contract-stabilization milestone. ## Contributing @@ -95,4 +105,4 @@ This project is licensed under the MIT License. See `LICENSE`. ## Contact -Questions or feedback: [email protected] +Questions or feedback: [email protected] |
