Skip to content

Restructure the README to the portfolio standard - #192

Merged
AdamXweb merged 3 commits into
mainfrom
docs/readme-standard
Aug 11, 2026
Merged

Restructure the README to the portfolio standard#192
AdamXweb merged 3 commits into
mainfrom
docs/readme-standard

Conversation

@adamXbot

@adamXbot adamXbot commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

First repo onto the standard README shape, as the reference implementation for the rest of the portfolio.

Merge order — this goes last

  1. #191 first — it also rewrites README.md, so these conflict. It was opened first and carries the canonical docs-domain rename.
  2. The status hub — the badge reads privacykey/.github/badges/privacytracker.json, which doesn't exist yet, so it currently renders resource not found.
  3. Then rebase and merge this.

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.md and CHANGELOG.md were linked from the README but don't exist here. Contributing now lists the commands CI actually runs, and documentation points at docs/ARCHITECTURE.md and AGENTS.md, which do exist.

The docs site stays unlinked for now: both privacytracker-docs.privacykey.org and #191's canonical docs.privacytracker.privacykey.org return HTTP 000. The links go back in as soon as Mintlify and DNS are connected.

Corrections to what I said earlier

  • SUPPORT.mddocs: point at the canonical docs domain, and fix the tap link #191 adds it. I'll link it on the rebase.
  • privacykey/.github is 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

@adamXbot
adamXbot marked this pull request as ready for review August 8, 2026 14:54
@adamXbot
adamXbot requested a review from AdamXweb as a code owner August 8, 2026 14:54
@adamXbot

adamXbot commented Aug 9, 2026

Copy link
Copy Markdown
Collaborator Author

Heads-up on merge order — this drops every documentation link.

Current main references docs.privacytracker.privacykey.org 6 times (the masthead Documentation link and the whole Learn more section). This branch's README contains only github.com and img.shields.io URLs, so merging it as-is removes the docs site from the README entirely.

Those links were only just corrected in #191 — they previously pointed at privacytracker-docs.privacykey.org, which does not resolve and never will under that name. The scheme is docs.<product>.privacykey.org.

Also dropped: the Homebrew tap link, which #191 fixed from github.com/privacykey/tap (404) to privacykey/homebrew-tap.

Not blocking — the restructure itself reads well. But worth re-adding a Documentation section pointing at https://docs.privacytracker.privacykey.org before this lands, or the fix in #191 is undone for the README.

Adam Kostarelas and others added 3 commits August 11, 2026 02:23
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>
@adamXbot
adamXbot force-pushed the docs/readme-standard branch from e2f3b66 to cdb4b54 Compare August 10, 2026 16:23
@adamXbot

Copy link
Copy Markdown
Collaborator Author

Rebased onto main now that #191 has landed.

Two things changed in the resolve, both because main moved:

  • CONTRIBUTING.md, CODE_OF_CONDUCT.md, SUPPORT.md and CHANGELOG.md now exist, so they are linked again. The original PR removed those links because none of the four was in the repo at the time — that rationale is no longer true.
  • The docs site stays unlinked. docs: point at the canonical docs domain, and fix the tap link #191's canonical docs.privacytracker.privacykey.org still returns HTTP 000, so linking it would reintroduce the dead links this PR exists to remove. Worth a follow-up once Mintlify and DNS are connected.

Every relative link re-verified against the rebased tree — all ten resolve.

@AdamXweb
AdamXweb merged commit 196df5f into main Aug 11, 2026
11 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants