Skip to content

docs(readme): two dead directories and an installer we no longer have - #561

Merged
oddharsh merged 1 commit into
mainfrom
docs/readme-layout-bun
Aug 24, 2026
Merged

oddharsh merged 1 commit into
mainfrom
docs/readme-layout-bun

Conversation

@oddharsh

Copy link
Copy Markdown
Owner

The "where things are" tour opened on two directories that no longer exist, and
the one command it gives a newcomer fails on its first half.

line says actually
www/ everything the site serves gone since the 2026-08-18 split: public/ is the bytes, src/ is everything authored
scripts/ every dev tool merged into tools/ the same day
pnpm install && bun run dev packageManager is bun@1.4.0, the lockfile is bun.lock, and neither pnpm-lock.yaml nor pnpm-workspace.yaml is in the tree

All three drifted the same way. The section was written in #340 (the reorganize)
and the only edits since were #483 swapping pnpm run for bun run and #538
adding the cf-garage --x-new-config note, so neither the layout move nor the
package-manager move came back through here.

Everything else in the file is still correct: config/, docs/, the apps the
site worker bundles, the three self-deploying auxiliaries, pipelines/,
design/, and both wrangler configs at the root.

Nothing in tools/ or CI reads README.md (the only hit is perf-history.yml,
which writes the README on its own machine-owned branch), so this could go stale
without failing anything, and there is nothing to run against it.

The tour still opened on `www/` and `scripts/`, neither of which has existed
since the 2026-08-18 split: served bytes are `public/`, everything authored is
`src/`, and the dev tools merged into `tools/`. The one command a newcomer runs
also still started with `pnpm install`, which now fails outright, since
`packageManager` is bun@1.4.0, the lockfile is `bun.lock`, and there is no
`pnpm-lock.yaml` or `pnpm-workspace.yaml` left in the tree.

All three drifted the same way. This section was written in #340 and the only
edits since were #483 swapping `pnpm run` for `bun run` and #538 adding the
cf-garage note, so neither the layout move nor the package-manager move came
back through here. Nothing asserts on this file, which is why it could go stale
without failing anything.
@oddharsh
oddharsh merged commit 82330ef into main Aug 24, 2026
6 checks passed
@oddharsh
oddharsh deleted the docs/readme-layout-bun branch August 24, 2026 19:26
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.

1 participant