docs: point at the canonical docs domain, and fix the tap link - #191
Merged
Conversation
The docs domain scheme is docs.<product>.privacykey.org — the form docs-privacysentinel already uses. This repo referenced privacytracker-docs.privacykey.org in 29 files, which does not resolve and never will under that name. Most of these are user-facing rather than internal notes: - README.md links it 7 times, including the masthead Documentation link. - src-tauri/src/app_menu.rs is the desktop app's Help menu. - .github/SECURITY.md, SUPPORT.md, and in-app help links in SettingsView, AnnotationsSidebar, AuditBundleImport, DevOptionsFeatureFlagPanel, YourFocusCard and FocusPreviewBanner. Separately: the README's Homebrew tap link pointed at github.com/privacykey/tap, which 404s. The repo is privacykey/homebrew-tap. The `brew tap privacykey/tap` command above it is correct — brew expands the short form — so only the hyperlink was wrong. Neither change affects behaviour; every edit is a URL string.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Found during an accuracy sweep of the privacykey docs and website repos.
The docs domain
This repo references
privacytracker-docs.privacykey.orgin 29 files. That host does not resolve, and it isn't the agreed scheme — docs sites aredocs.<product>.privacykey.org, whichdocs-privacysentinelalready uses. Replaced throughout.Most of these are user-facing, not internal notes:
README.md(×7)src-tauri/src/app_menu.rs.github/SECURITY.md,SUPPORT.mdSo today a user clicking Help in the shipped macOS app lands on a dead host.
The Homebrew tap link
README.mdlinked the tap asgithub.com/privacykey/tap→ 404. The repo isprivacykey/homebrew-tap. Thebrew tap privacykey/tapcommand directly above it is correct, since brew expands the short form — only the hyperlink was wrong.Scope
Every edit is a URL string; no behaviour changes. Worth noting the domain still needs DNS + Mintlify connect before any of these resolve — this change makes sure they point at the right name when it goes up.
Companion PR: privacykey/docs-privacytracker#2 (which also corrects the Plausible domain from
docs.privacytracker.io).