docs(readme): rewrite README as a concise, marketing-focused landing page#6736
Merged
Conversation
…page Cut the README from 1042 to ~140 lines. Detailed content (language feature tables, CLI flags, project structure, release runbook, telemetry payload schema) now lives in the docs site; the README focuses on the pitch: comparison table vs Node/Bun/Electron, measured benchmark highlights with linked sources, showcase, quick start, and community links.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README is substantially rewritten to update Perry’s positioning, runtime comparisons, benchmarks, feature claims, onboarding examples, showcase content, documentation links, community resources, privacy guidance, and sponsor presentation. ChangesREADME refresh
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
104-113: 📐 Maintainability & Code Quality | 🔵 TrivialTrack the deferred documentation migration.
The README now redirects “everything else” to the docs site, but the PR objectives identify telemetry details and the release runbook as requiring follow-up migration into
docs/src/. Confirm those pages exist or add a tracked follow-up and links before treating the documentation transition as complete.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 104 - 113, Update the Documentation section to track the deferred migration of telemetry details and the release runbook: verify corresponding pages exist under docs/src/, add the missing pages or a tracked follow-up if needed, and link them from README.md before considering the documentation transition complete.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 5: Revise the README hero claims and the comparison table covering lines
21–28 to qualify “no runtime,” “just a binary,” and native machine-code behavior
as applying only to native targets. Add an explicit caveat that web/WASM output
runs within a browser or host runtime, while preserving the existing
native-target messaging.
---
Nitpick comments:
In `@README.md`:
- Around line 104-113: Update the Documentation section to track the deferred
migration of telemetry details and the release runbook: verify corresponding
pages exist under docs/src/, add the missing pages or a tracked follow-up if
needed, and link them from README.md before considering the documentation
transition complete.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
- Qualify the no-runtime claim: hero lists native targets only, web/WASM moved to an explicit caveat (also footnoted under the comparison table) - Link the migrated telemetry and releasing docs pages (#6737) from the Documentation section
proggeramlug
added a commit
that referenced
this pull request
Jul 21, 2026
…reshness gate (#6739) #6736 rewrote README.md as a concise marketing landing page with a different, hand-curated performance section and intentionally dropped the auto-generated `<!-- public-node-bun:start/end -->` block. The lint job's "Public benchmark evidence freshness" step still ran `public_baseline.py check`, which *requires* that block, so it failed on every PR ("README generated markers are missing") — a repo-wide lint breakage unrelated to any PR's code. Relax the gate without touching the README: a new `benchmarks/ ci_public_baseline_check.py` reuses `public_baseline`'s functions to enforce artifact freshness/integrity (age, schema, source + harness fingerprints) and `suite/results/RESULTS.md` drift, but validates the README table only when its generated markers are present. The lint step now calls it instead of `public_baseline.py check`. The policy lives in a separate module on purpose: `public_baseline.py` is a fingerprinted harness file (`HARNESS_PATHS`), so relaxing the check *inside* it would change `harness_fingerprint` and trip `validate_public`'s "harness changed; regenerate" guard — unsatisfiable without re-running the full Node/Bun/Perry suite. Importing its functions from a new file leaves the fingerprint intact. README.md is unchanged. Co-authored-by: Ralph Küpper <ralph@skelpo.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
2 participants
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.
Summary
Rewrites the README from 1042 lines to ~140, turning it into a landing page that sells Perry and defers all detail to the docs site.
New structure:
benchmarks/honest_bench/REPORT.mdorbenchmarks/polyglot/RESULTS.md, with the explicit note that we also publish the workloads where V8 still wins and an invitation to run./benchmarks/run_public_baseline.shRemoved (all covered by the docs site): language/stdlib/package feature tables, compiler flags, project structure, compiler optimizations list, plugins/Geisterhand/containers/i18n/widgets sections, dev commands.
Content that existed only in the README — the full telemetry payload/redaction writeup and the release runbook — is migrated into
docs/src/in #6737 (merge that one first so the README's telemetry-docs link resolves; the README also keeps a short privacy summary).No version bump / CHANGELOG entry per contribution guidelines — maintainer folds those in at merge.
Validation
benchmarks/, showcase/sponsor images)docs/src/SUMMARY.mdSummary by CodeRabbit