Restructure the README to the portfolio standard - #79
Merged
Conversation
Rewrites README.md to the shared section order (hero, badges, disclosure, overview, what it does, get it, docs, contributing, licence) and moves the long-form material into files of its own rather than deleting it. Corrections: - The one-line description read "Self-hostable mantis key service", which looks like a bad find/replace. Restored to "Self-hostable canary key service", matching the description in the docs source. - The beta warning pinned component versions in prose: "CLI v0.1.6, full server v0.1.1, edge v0.1.3". CLI is 0.2.0 and the edge worker is 0.1.4, so two of the three were wrong. Version numbers now come from the release badge instead of prose, so they cannot go stale again. - All eight documentation links pointed at privacykey/mantis-docs, a repo that has been renamed to privacykey/docs-mantis. They only resolved via GitHub's rename redirect. Repointed at the real name. - "License" -> "Licence" for the portfolio's British spelling. Badges: replaced the ad-hoc row with the four standard badges (status, release, licence, CI). All four were verified to render a real value. The decorative Homebrew and Cloudflare Workers badges were dropped; the brew install path is in "Get it" and the edge worker has its own section. The HTTPS-only warning is kept as its own block below the disclosure. It makes a different claim to the pre-1.0 notice and must not be merged into it. Moved out (README 9702 -> 6625 bytes): - Run-from-source setup, the CI job matrix, test tiers and benchmarks -> CONTRIBUTING.md (new) - Both quickstarts, the Fly.io launch script, and the component index -> docs/GETTING-STARTED.md (new) - Fleet / MDM provisioning -> docs/FLEET-PROVISIONING.md (new) Every relative path and every URL in the four files was checked; all resolve. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
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.
Brings
README.mdinto the shared portfolio structure: hero, badge row, fenced disclosure block, then overview / what it does / get it / docs / contributing / licence.Wrong facts removed
v0.1.6, full serverv0.1.1, edgev0.1.3at time of writing". Actual versions onmainare CLI 0.2.0 and edge 0.1.4 — two of the three were wrong. Prose version numbers are now gone entirely; the release badge carries the version so it cannot drift again..zip" count could not be confirmed from the source, so the count was dropped. The.zipartefact itself is real and stays.Links
privacykey/mantis-docs— that repo has been renamed toprivacykey/docs-mantis. They resolved only through GitHub's rename redirect, which is not a guarantee. All eight repointed at the real name.docs.jsonin the docs repo defines no domain, and neitherdocs.privacykey.orgnormantis.privacykey.orgresolves. The README now says plainly that the rendered site is not live yet and links the Markdown on GitHub, rather than implying a docs host exists.Badges
Replaced the ad-hoc row with the four standard badges. Each was verified to render a real value rather than "no status" / "not found":
status: Activerelease: cli-v0.2.0licence: MITci: passingci.ymldoes run onmain(on: push: branches: [main]) and has green runs there, so the CI badge is genuine. The decorative Homebrew and Cloudflare Workers badges were dropped — thebrew installline is in "Get it" and the edge worker has its own paragraph.The status badge currently resolves, but note it reads from the
privacykey/.githubhub; if the status-hub PR is still in flight it may briefly render "resource not found". The path is correct.Kept deliberately
The HTTPS-only warning is preserved as its own block immediately below the disclosure. It makes a different claim to the pre-1.0 notice and is deliberately not merged into it.
Size
README.md9702 → 6625 bytes. Nothing was deleted; the long-form material moved:CONTRIBUTING.md(new) — run from source, the full CI job matrix, the three test tiers, benchmarks, versioning. Records that pnpm is the only supported package manager and that CI reads the pinned version frompackageManager.docs/GETTING-STARTED.md(new) — both quickstarts, bootstrap admin key, the one-command Fly.io launch, edge caveats, component index.docs/FLEET-PROVISIONING.md(new) — idempotentexternal_idminting and enrollment-scoped API keys.