summaryrefslogtreecommitdiff
path: root/Docs
diff options
context:
space:
mode:
authorChristian Cleberg <[email protected]>2026-08-02 15:29:31 -0500
committerChristian Cleberg <[email protected]>2026-08-02 15:35:31 -0500
commitfe83ff502ffcaa59c7a22471c634d565972e7644 (patch)
treefd17e5bc79d79973209ef712d44ede00b3a009e4 /Docs
parenta6ed5c3546300994ab4d8b9840445d384b0083ed (diff)
downloaddomain-dig-main.tar.gz
domain-dig-main.tar.bz2
domain-dig-main.zip
convert readme to nfo; convert docs to txt; relicense to 0bsdHEADmain
Diffstat (limited to 'Docs')
-rw-r--r--Docs/ACCESSIBILITY.txt (renamed from Docs/ACCESSIBILITY.md)0
-rw-r--r--Docs/ARCHITECTURE.txt (renamed from Docs/ARCHITECTURE.md)4
-rw-r--r--Docs/data-migration.txt (renamed from Docs/data-migration.md)2
-rw-r--r--Docs/local-api.txt (renamed from Docs/local-api.md)0
4 files changed, 3 insertions, 3 deletions
diff --git a/Docs/ACCESSIBILITY.md b/Docs/ACCESSIBILITY.txt
index 6e82055..6e82055 100644
--- a/Docs/ACCESSIBILITY.md
+++ b/Docs/ACCESSIBILITY.txt
diff --git a/Docs/ARCHITECTURE.md b/Docs/ARCHITECTURE.txt
index d0d2108..dbf66d1 100644
--- a/Docs/ARCHITECTURE.md
+++ b/Docs/ARCHITECTURE.txt
@@ -76,14 +76,14 @@ The app remains local-first. Purchase and entitlement code is local app infrastr
- `DomainReportExporter`
- `LocalAPIModels`
-`v5.0.0` stabilized this contract: `LocalAPIContract` is the single source of truth for the `v1` wire version and JSON encoder, the response envelope and payloads are documented, and the shape is regression-locked by `LocalAPIContractTests`. See [local-api.md](local-api.md) for the endpoint and compatibility reference, and [data-migration.md](data-migration.md) for how the persisted store is versioned across app updates.
+`v5.0.0` stabilized this contract: `LocalAPIContract` is the single source of truth for the `v1` wire version and JSON encoder, the response envelope and payloads are documented, and the shape is regression-locked by `LocalAPIContractTests`. See [local-api.txt](local-api.txt) for the endpoint and compatibility reference, and [data-migration.txt](data-migration.txt) for how the persisted store is versioned across app updates.
## Testing
Two test targets run from the `DomainDig` scheme's test action:
- `DomainDigTests` — unit coverage of the deterministic core: `DomainReportBuilder`, `DomainReportExporter`, `DiffService`, `DomainDataPortabilityService` (merge/replace dedup), the store-migration runner, and the Local API contract. `SnapshotFixture` builds the deep `LookupSnapshot`/`DomainReport` models through the real builder so tests construct inputs without wiring every field.
-- `DomainDigUITests` — Apple's `performAccessibilityAudit()` over every primary screen at default and largest Dynamic Type, plus metadata and screenshot assertions. See [ACCESSIBILITY.md](ACCESSIBILITY.md).
+- `DomainDigUITests` — Apple's `performAccessibilityAudit()` over every primary screen at default and largest Dynamic Type, plus metadata and screenshot assertions. See [ACCESSIBILITY.txt](ACCESSIBILITY.txt).
A plain `xcodebuild test` (and CI) runs both. The unit net went in first in `v5.0.0` and is what made the god-file decomposition safe to attempt.
diff --git a/Docs/data-migration.md b/Docs/data-migration.txt
index 1ae4030..c97a1be 100644
--- a/Docs/data-migration.md
+++ b/Docs/data-migration.txt
@@ -77,7 +77,7 @@ backup export/import). Its contract:
4. Add a `DataMigrationServiceTests` case that seeds a pre-`N` fixture, runs
`migrateIfNeeded`, and asserts the upgrade plus the version stamp.
5. If the change also alters the export shape, bump
- `DomainDigBackup.currentSchemaVersion` and update `Docs/local-api.md` /
+ `DomainDigBackup.currentSchemaVersion` and update `Docs/local-api.txt` /
backup validation as needed.
## Backup import compatibility
diff --git a/Docs/local-api.md b/Docs/local-api.txt
index a0cebdc..a0cebdc 100644
--- a/Docs/local-api.md
+++ b/Docs/local-api.txt