docs(docs): add a privacy policy + make the docs site third-party-free (SignPath) - #148
Conversation
…e (SignPath) SignPath's free-for-OSS signing program requires a project privacy-policy URL. Add `docs/privacy.md` (wired into the mkdocs nav → a stable /privacy/ URL) stating Tether's actual data practices, verified against the code: - the desktop app is local-only with NO telemetry/analytics/network calls (the only network-ish call is socket.gethostname() for the local `.lock` sidecar); - the `.tether` store's provenance records the OS username (the annotation "labeler"); the separate `.lock` sidecar additionally records hostname + pid for write-lock coordination — all stored locally, never transmitted; - GitHub Pages is the host; the site itself sets no tracking cookies and runs no third-party analytics. Also set `theme.font: false` in mkdocs.yml so Material uses system fonts instead of loading Google Fonts — the built site now makes NO third-party asset request (no visitor IP sent to Google), which makes the policy's "no third-party" statement literally true. An adversarial review caught both the Google-Fonts gap and an over-statement of what the `.tether` store records (host/pid are `.lock`-only, not in the store) — corrected here. No src/schema/lock change.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughAdds a privacy policy covering the Tether application, documentation site, distribution, and data handling. Updates MkDocs to link the policy and use visitor system fonts without external font requests. ChangesPrivacy documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
@coderabbitai review |
✅ Action performedReview finished.
|
|
@coderabbitai full review |
✅ Action performedFull review finished. |
What & why
SignPath's free-for-OSS signing program requires a privacy-policy URL. This adds
docs/privacy.md, wired into the mkdocs nav so it publishes at a stable/privacy/URL on the live docs site.The policy (accurate, verified against the code)
socket.gethostname()for the local.locksidecar..tetherstore records the OS username (the annotation "labeler"); the separate.locksidecar additionally records hostname + pid for one-writer coordination. All local, never transmitted.Also: the site is now third-party-free
theme.font: falseinmkdocs.ymlmakes Material use system fonts instead of loading Google Fonts — so the built site makes no third-party asset request (no visitor IP sent to Google). Verified: the built site has 0 references tofonts.googleapis.com/fonts.gstatic.com. This makes the policy's "no third-party" statement literally true.Verified locally
mkdocs build --strict0 warnings · privacy page builds · 0 Google-Fonts references in the built site ·test_adr_index5/5 ·reusecompliant.A 2-lens adversarial pre-review caught (and I fixed): the Google-Fonts third-party call, an over-statement that host/pid land in the
.tetherstore (they're.lock-only), and a children's-privacy wording contradiction.Self-review (PLAN §12.4)
docs-build --strictgreen;test_adr_index(mkdocs wiring guard) green;reusegreen.Summary by CodeRabbit