docs: remove stale DISTRIBUTION.md - #3626
Merged
Merged
Conversation
DISTRIBUTION.md was last touched 2026-03-06 (54f01a6) and is now materially wrong in ways that would actively mislead anyone who read it. It duplicates the published installation page, which is the page users actually read and the one the docs quality validator polices; a second, unpoliced copy of installation instructions is how the drift in veryfront-issue-inbox#475 happened. Verified wrong against the current release: - Claimed the npm package is "~50KB" that "downloads the binary during postinstall". `npm view veryfront dist.unpackedSize` is 27,428,043 bytes across 7,898 files, with the framework inlined. Off by ~550x. - Claimed binaries are "~254MB", and built a whole UPX section on "254MB -> 80MB". Release v0.1.1229 assets are 0.94-1.13 GB. - Listed Homebrew as "(Future)" with a hand-written formula. homebrew/ veryfront.rb is checked in and cicd.yml has an update-homebrew job that opens PRs against veryfront/homebrew-tap. - Told maintainers to bump `npm/package.json`. There is no npm/ directory; version lives in deno.json. - Documented a manual `npm login` + `npm publish` release. Publishing is the RC train in cicd.yml with OIDC trusted publishing (id-token: write), not a static token. - Inlined a full install.sh under "Create install.sh", which has since diverged from the real scripts/install.sh (--version/--dir flags, ~/.veryfront/bin, checksum verification). - Predates the 27 @veryfront/ext-* packages, the proxy binaries, and the SBOM release assets entirely. References checked before deleting: no file in this repo, in veryfront-docs, veryfront-studio, or veryfront-api mentions DISTRIBUTION.md. Not in CODEOWNERS, not in sync-docs.yml, not in any script, workflow, or test. Nothing asserts the file exists.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
📝 WalkthroughWalkthroughThe Changes
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
kojiwakayama
enabled auto-merge
August 12, 2026 06:16
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Aug 12, 2026
kwakayama
reviewed
Aug 12, 2026
kwakayama
left a comment
Contributor
There was a problem hiding this comment.
No actionable findings.
DISTRIBUTION.md:1is the sole changed path; no tracked file at head references it.- Maintained install guidance remains at
docs/getting-started/installation.md:20-143andREADME.md:45-53; those are included in public-doc validation (scripts/docs/validate-public-docs.ts:23-29). - Removal eliminates conflicting guidance, including the obsolete “Homebrew (Future)” claim at
DISTRIBUTION.md:57; CI updates Homebrew releases at.github/workflows/cicd.yml:947-1005. - Release behavior is unchanged and defined by
deno.json:3and.github/workflows/cicd.yml:481-503,768-907. Existing binary integrity handling remains untouched atscripts/postinstall.js:102-129. - No test changes are warranted for deletion of an unreferenced Markdown document; the supplied required-check snapshot is green.
Rubric: correctness 40/40, tests 20/20, reliability/security 15/15, maintainability 15/15, scope/docs 10/10.
Review-Gate:
Reviewer: Codex
Reviewed-SHA: 674f0f6
Score: 100/100
Actionable-Findings: 0
Verdict: APPROVE
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Aug 12, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Aug 12, 2026
This was referenced Aug 12, 2026
Merged
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.
Removes
DISTRIBUTION.md(621 lines), last touched 2026-03-06 in 54f01a6.The decision is remove, not update. It duplicates
Installation, which is the page
users actually read and the one the docs quality validator polices. A second, unpoliced copy of
installation instructions is exactly how the drift in veryfront-issue-inbox#475 happened, so
refreshing it would just reset the clock on the same failure.
What was verified wrong
Every item below was checked against the current release, not inferred.
DISTRIBUTION.mdnpm view veryfront dist.unpackedSize= 27,428,043 bytes across 7,898 files, framework inlined. Off by ~550x.v0.1.1229assets are 0.94–1.13 GB (veryfront-macos-arm64941 MB,veryfront-linux-arm641.13 GB). The whole optimization section is built on a number that is ~4x off.homebrew/veryfront.rbis checked in, andcicd.ymlhas anupdate-homebrewjob (line 947) that opens PRs againstveryfront/homebrew-tap.npm/package.json(version)"npm/directory. Version lives indeno.json.npm login&&npm publishcicd.yml—prepare-rc-build.ts→build:npm→publish-npm-packages.sh, under OIDC trusted publishing (id-token: write), not a static token.install.sh" with a full inlined scriptscripts/install.shalready exists and has diverged:--version/--dirflags, installs to~/.veryfront/bin(notsudo mvto/usr/local/bin), and verifies checksums.@veryfront/ext-*packages, theveryfront-proxy-*binaries, and the SBOM release assets (all.json,dependencies-by-manifest.json, per-extension JSON) entirely.Worth noting the file was never merely stale — following its release section would have had a
maintainer editing a path that does not exist and publishing by hand outside the OIDC train.
References checked before deleting
Nothing points at this file. Searched for
DISTRIBUTION.mdin:DISTRIBUTIONmatch in the repo isthe Apache boilerplate line in
LICENSE("TERMS AND CONDITIONS FOR USE, REPRODUCTION, ANDDISTRIBUTION"), unrelated.
README.md,CONTRIBUTING.md,AGENTS.md,CONTEXT.md— no link to it..github/CODEOWNERS— not listed (it namesSECURITY.md,CONTRIBUTING.md,CLA.md,CLA-CORPORATE.mdonly)..github/workflows/— no reference;sync-docs.ymlonly watchesdocs/paths.scripts/,tests/,src/,templates/,rfcs/,.claude/— no reference.scripts/build/npm-package-metadata.ts— does not ship root markdown, so the published package isunaffected.
No test or lint rule asserts the file exists. The nearest analogue,
src/security/repository-hardening.test.ts, pinsSECURITY.mdand CODEOWNERS specifically andnever touches this file. Pre-push (fmt, lint, typecheck, full suite) is green.
Content that is NOT covered elsewhere
Per the "deleting unique information is worse than a stale file" rule, here is the audit rather than
a silent drop. Most of the file is genuinely redundant:
README.mdalready documents bothcurl … install.sh | sh(line 48) andbrew install veryfront/tap/veryfront(line 50); the docs page covers every package manager.CONTRIBUTING.md§ Release Process, plusscripts/release.tsandcicd.ymlas the executable source of truth.cicd.yml, which also does SBOMgeneration the doc never knew about.
Four things have no home anywhere else. I am not claiming they should be dropped on the floor:
xattr -d com.apple.quarantine veryfront). Genuinelyuser-facing and not documented anywhere. It only bites users who download a binary from GitHub
Releases in a browser —
curland Homebrew do not set the quarantine bit. Proposal: add it asa troubleshooting entry on the installation docs page, where the validator will police it.
codesign -s "Developer ID Application") and GPG detached signatures.Grepping
.github/andscripts/forcodesign/gpgreturns nothing — these were neverimplemented. This is an unimplemented wish, not documentation, and the repo has since moved to
SBOMs plus npm provenance via OIDC. Proposal: file as a supply-chain issue if still wanted,
so it is tracked as work rather than asserted as fact.
are ~1 GB. Proposal: issue, not doc — and it needs re-measuring before anyone acts on it.
reference. Proposal: issue-inbox items.
I did not create those issues as part of this PR — happy to, if you want them tracked.
Adjacent drift spotted, deliberately not fixed here
CONTRIBUTING.md§ Release Process troubleshooting still says "Check thatNPM_TOKENsecret is set",which the OIDC trusted-publishing migration made obsolete. Left alone to keep this PR a clean
deletion; flagging it so it does not become the next
DISTRIBUTION.md.Test plan
loop has already resolved" after a clean
0 failed); re-ran unmodified and it passed.Summary by CodeRabbit