docs: rewrite the README around the new landing chapters - #325
Merged
Conversation
The homepage was rebuilt around what the runtime removes (#311, #313, #315, #316, #317, #323), so the README no longer matched it. Re-order the README on the same chapters: the removal thesis, the three frameworks over one native tree, the component-to-pixel stack against a browser's, compiled motion, the measured cost on a PSP and on a Mac, the frame contract, cores mounted per content, hardware compatibility receipts, and what ships on the runtime. Also: - drop `bun run vapor:check`, which is not a package script; Pocket Vapor is now one section pointing at `vapor:dev`, `vapor:test`, and the compiler CLI - take the desktop numbers from docs/bench/gpui-vs-tauri-electron-2026-08-18 and link the report and `tools/bench-desktop.ts` - turn the platform table into per-entry receipts (post or pull request) and keep contracts/spec/platforms.ts as the authoritative inventory Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
doodlewind
marked this pull request as ready for review
August 22, 2026 16:48
doodlewind
added a commit
that referenced
this pull request
Aug 23, 2026
One positioning sentence now carries the project everywhere it is defined: "PocketJS is a portable application runtime that turns modern component code into native pixels across radically different hardware." It replaces the UI-runtime-minus-the-browser framing in the landing hero, the homepage and site-wide meta descriptions, the docs overview and architecture intros, and the npm package description. The landing headline becomes "UI runtime for every kind of computer"; the pinned hero copy in tests/site-stage.test.ts follows. The README keeps the chapter order it gained in #325 but drops the landing voice: section names are now plain technical headings (Programming model, Rendering and execution, Performance, Native modules, Hardware support, Applications, Getting started, Ahead-of-time compilation, Repository layout, Building and testing, Documentation), prose is third person, and the frameworks, styling, animation and target-admission material sits under subsections. Adds a Contents list and a Documentation index; keeps every measurement, receipt link and attribution. Verified: `bun run test` (11/11 stages), `bun run site:build`, and a headless Chrome measurement of the three-line headline (widest line 445 px against 651 px of plate at 1600w, no overflow at 1600/1280/820/390 px). Co-authored-by: Claude Opus 5 (1M context) <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
1 participant
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.
What
The homepage was rebuilt around what the runtime removes (#311, #313, #315, #316, #317, #323); the README still opened on the old runtime family / four kinds of software / two execution paths framing. This re-orders the README on the landing's chapters.
pocket check, component-to-pixel stack vs a browser'sFixes along the way
bun run vapor:checkdoes not exist as a package script. Pocket Vapor shrinks to one section ("Machines without a JavaScript engine") usingvapor:dev,vapor:test, andbun vapor/compiler/cli.ts … --target gb.docs/bench/gpui-vs-tauri-electron-2026-08-18.md(149/380/301 ms cold start, 83/193/382 MB idle RSS, 1/4/5 processes, 10/9/242 MB on disk), with the report andbun tools/bench-desktop.tslinked, including where the pocket build loses.contracts/spec/platforms.tsstill named as the authoritative inventory.pocket checksnippet now says it runs from the app directory against itspocket.json(the CLI's--manifestdefault).Verification
pocketjs.devblog and docs slug used exists insite/nav.ts./markdownAPI locally and read end to end: 7 tables, 18 fenced blocks, bothtextdiagrams and the images render.Docs only — no code paths touched.
🤖 Generated with Claude Code