Restructure the README to the portfolio standard - #192
Conversation
|
Heads-up on merge order — this drops every documentation link. Current Those links were only just corrected in #191 — they previously pointed at Also dropped: the Homebrew tap link, which #191 fixed from Not blocking — the restructure itself reads well. But worth re-adding a Documentation section pointing at |
Fixed section order — hero, badges, disclosure, overview, install, data, contributing, licence — so every repo reads as one family. Removes five broken links. CONTRIBUTING.md, CODE_OF_CONDUCT.md, SUPPORT.md and CHANGELOG.md were all linked but have never existed in this repo, and the four links to privacytracker-docs.privacykey.org point at a host that does not resolve. The contributing section now carries the commands CI actually runs instead of pointing at a file that isn't there, and documentation links go to docs/ARCHITECTURE.md and AGENTS.md, which do exist. The status badge is a shields endpoint reading AdamXweb/AdamXweb, so the tier is never written into this README as prose — a status change stays a one-line edit in one file rather than a pull request here. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Each account now keeps its own status hub, so this badge is served from privacykey/.github rather than a personal profile repo — no cross-identity dependency for a privacykey product. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
AGENTS.md pins pnpm@11.1.2 via packageManager and every workflow installs from pnpm-lock.yaml; npm against that lockfile is explicitly unsupported. The commands listed here said npm. The CI badge is removed rather than left blank: ci.yml sets branches-ignore: [main], so CI never runs on the default branch and a status badge for it can only ever render empty. Omitting a badge that cannot resolve is the rule the template already applies elsewhere. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
e2f3b66 to
cdb4b54
Compare
|
Rebased onto main now that #191 has landed. Two things changed in the resolve, both because main moved:
Every relative link re-verified against the rebased tree — all ten resolve. |
First repo onto the standard README shape, as the reference implementation for the rest of the portfolio.
Merge order — this goes last
README.md, so these conflict. It was opened first and carries the canonical docs-domain rename.privacykey/.github/badges/privacytracker.json, which doesn't exist yet, so it currently rendersresource not found.I'll rebase onto #191 once it lands.
What changed
Fixed section order: hero → badges → disclosure → overview → install → data → contributing → licence. Four badges: status, release, licence, CI.
Broken links removed.
CONTRIBUTING.md,CODE_OF_CONDUCT.mdandCHANGELOG.mdwere linked from the README but don't exist here. Contributing now lists the commands CI actually runs, and documentation points atdocs/ARCHITECTURE.mdandAGENTS.md, which do exist.The docs site stays unlinked for now: both
privacytracker-docs.privacykey.organd #191's canonicaldocs.privacytracker.privacykey.orgreturn HTTP 000. The links go back in as soon as Mintlify and DNS are connected.Corrections to what I said earlier
SUPPORT.md— docs: point at the canonical docs domain, and fix the tap link #191 adds it. I'll link it on the rebase.privacykey/.githubis not a stub. It carries SECURITY.md, CONTRIBUTING.md and CODE_OF_CONDUCT.md as of 2026-08-07, so this repo already inherits org-level community health files. My earlier note claiming otherwise was from stale scan data.Why the status is a badge and not text
The tier word lives only in the generated badge. Writing it into the README as prose would make a status change a 34-file problem, and any README that lagged would contradict its own badge.
🤖 Generated with Claude Code