docs: move Privacy & Telemetry and Releasing runbook from README into mdBook#6737
Open
TheHypnoo wants to merge 3 commits into
Open
docs: move Privacy & Telemetry and Releasing runbook from README into mdBook#6737TheHypnoo wants to merge 3 commits into
TheHypnoo wants to merge 3 commits into
Conversation
… mdBook The README rewrite drops these two sections; this preserves them as dedicated docs pages (docs/src/cli/telemetry.md and docs/src/contributing/releasing.md) and adds them to SUMMARY.md. Content is verbatim from the pre-rewrite README except for mdBook anchor links and updating the stale 'Recent Changes in CLAUDE.md' release step to CHANGELOG.md.
|
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)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds documentation for Perry’s privacy and telemetry behavior and release process, with new table-of-contents links under CLI Reference and Contributing. ChangesTelemetry documentation
Release documentation
Estimated code review effort: 2 (Simple) | ~10 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 |
TheHypnoo
added a commit
that referenced
this pull request
Jul 21, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@docs/src/contributing/releasing.md`:
- Around line 43-46: Reconcile the CI coverage descriptions in the platform
matrix and the accompanying paragraph: update the Linux and Windows entries to
accurately reflect the automated doc-test coverage provided by test.yml, while
distinguishing checks that remain manual or build-only. Ensure the statements
consistently describe the same coverage across the table and the paragraph.
- Around line 31-35: Update the release instructions around the tag-push command
to reflect that release-packages.yml runs only after publishing the
corresponding GitHub Release (or via workflow_dispatch), not from pushing a tag
alone. Instruct maintainers to publish the GitHub Release after pushing the tag,
and update the referenced CI description so both sections consistently describe
the actual trigger.
- Around line 28-29: Update the release checklist in the contributing release
instructions to remove the stale CLAUDE.md “Current Version” update and retain
CHANGELOG.md as the release documentation target alongside Cargo.toml
workspace.package.version. Ensure the checklist no longer directs maintainers to
modify CLAUDE.md.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 48261114-edd8-4372-89c1-b1f0879eeee0
📒 Files selected for processing (3)
docs/src/SUMMARY.mddocs/src/cli/telemetry.mddocs/src/contributing/releasing.md
Comment on lines
+28
to
+29
| # Edit Cargo.toml workspace.package.version + CLAUDE.md "Current Version". | ||
| # Add a changelog entry in CHANGELOG.md. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Resolve the stale CLAUDE.md release reference.
The checklist still instructs maintainers to update CLAUDE.md, while the PR objective says this release-step reference was changed to CHANGELOG.md. As written, the runbook contradicts itself and can leave the documented version source incorrect.
Suggested correction
-# Edit Cargo.toml workspace.package.version + CLAUDE.md "Current Version".
+# Edit Cargo.toml workspace.package.version and update CHANGELOG.md.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| # Edit Cargo.toml workspace.package.version + CLAUDE.md "Current Version". | |
| # Add a changelog entry in CHANGELOG.md. | |
| # Edit Cargo.toml workspace.package.version and update CHANGELOG.md. | |
| # Add a changelog entry in CHANGELOG.md. |
🤖 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 `@docs/src/contributing/releasing.md` around lines 28 - 29, Update the release
checklist in the contributing release instructions to remove the stale CLAUDE.md
“Current Version” update and retain CHANGELOG.md as the release documentation
target alongside Cargo.toml workspace.package.version. Ensure the checklist no
longer directs maintainers to modify CLAUDE.md.
Comment on lines
+43
to
+46
| | **macOS** (arm64 + x86_64) | `cargo test` + `run_parity_tests.sh` + `scripts/run_doc_tests.sh` | Yes, `test.yml` (arm64 only) | | ||
| | **Linux glibc** (x86_64 + aarch64) | Same, under `xvfb-run -a` for UI; `apt install libgtk-4-dev libadwaita-1-dev xvfb` first | Partial — release build only | | ||
| | **Linux musl** (x86_64 + aarch64) | Release build via `release-packages.yml`; spot-check a compiled `hello.ts` runs on Alpine | Build only | | ||
| | **Windows** (x86_64 MSVC) | `scripts/run_doc_tests.ps1`; smoke-test `perry compile hello.ts -o hello.exe && .\hello.exe` | Build only | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Reconcile the platform CI coverage claims.
The table says Linux and Windows are “Build only,” but the following paragraph says Linux and Windows doc-tests are automated in test.yml. Maintainers cannot determine which major-release checks are covered by CI versus which must be run manually.
Also applies to: 55-57
🤖 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 `@docs/src/contributing/releasing.md` around lines 43 - 46, Reconcile the CI
coverage descriptions in the platform matrix and the accompanying paragraph:
update the Linux and Windows entries to accurately reflect the automated
doc-test coverage provided by test.yml, while distinguishing checks that remain
manual or build-only. Ensure the statements consistently describe the same
coverage across the table and the paragraph.
TheHypnoo
added a commit
that referenced
this pull request
Jul 21, 2026
- 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
…ctual CI - release-packages.yml triggers on a published GitHub Release (or workflow_dispatch), not on the tag push; document the extra publish step and retitle §3 accordingly (anchor updated) - doc-tests: only the macOS lane runs in test.yml — the Linux (gtk4) and Windows matrix entries are disabled pending testkit fixes; the old 'Linux + Windows doc-tests are automated' claim was stale - clarify the version-bump comment: Cargo.toml and CLAUDE.md 'Current Version' move together (kept — CLAUDE.md still carries that line), changelog entry goes in CHANGELOG.md
proggeramlug
pushed a commit
that referenced
this pull request
Jul 21, 2026
…page (#6736) * docs(readme): rewrite README as a concise, marketing-focused landing 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. * docs(readme): link privacy section to the new telemetry docs page (#6737) * docs(readme): address CodeRabbit review - 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
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.
The README rewrite (
docs/readme-cleanup) shortens the README, but two blocks it removes exist nowhere else. This PR preserves them as dedicated mdBook pages before that content is lost:docs/src/cli/telemetry.md— the full "Privacy & Telemetry" section: both opt-in channels (telemetry.enabled,telemetry.compatibility_reports/ feat(telemetry): opt-in compatibility reports for unsupported TS/Node features #849), the complete compatibility-report payload schema, redaction rules, the 30-day dedup cache, and theperry doctorinspection flags. Previously the docs only mentionedPERRY_NO_TELEMETRYin one table row of the perry.toml reference; this page is now cross-linked from there.docs/src/contributing/releasing.md— the maintainer release runbook: pre-release checklist, major-release per-platform verification matrix, the iOS/tvOS simulator-run recipe (PERRY_UI_TEST_MODE=1), whatrelease-packages.ymldoes on the tag, release gates, and failure recovery.Both pages are added to
SUMMARY.md. Content is verbatim from the pre-rewrite README except:§3cross-reference became an in-page anchor link;CHANGELOG.md, matching the current workflow (the README predated the CHANGELOG split).No version bump or CHANGELOG entry (maintainer handles at merge).
Summary by CodeRabbit