fix(readme): regenerate root README mirror to match package/README.md - #19
Merged
Merged
Conversation
The root README.md is a generated byte-identical mirror of the canonical package/README.md (see scripts/sync-readme.mjs + the readme-sync rule). Commit 779ad52 hand-edited the root mirror directly, which drifted it from canonical and broke the ts-checks `readme-check` gate on main. Regenerated via `node scripts/sync-readme.mjs` so `--check` passes again. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Hh2Lo6FAPGaVgRkpkE2YwW
Deploying react-native-ecr17-protocol with
|
| Latest commit: |
82cda1f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fdaffaaf.react-native-ecr17-protocol.pages.dev |
| Branch Preview URL: | https://claude-dependabot-security-p.react-native-ecr17-protocol.pages.dev |
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.
Problem
The
readme-checkstep ints-checksCI (node scripts/sync-readme.mjs --check) fails onmainwith "README.md is out of sync with package/README.md". This blocks unrelated PRs (e.g. Dependabot #18).Root cause
The root
README.mdis a generated byte-identical mirror of the canonicalpackage/README.md(seescripts/sync-readme.mjsand the repo's readme-sync rule). Commit 779ad52 hand-edited the root mirror directly — adding a Rust/Tauri sibling callout only to the root — which is exactly the anti-pattern the rule forbids ("Never hand-edit the root README.md"). That drifted the mirror from canonical and broke the gate.Fix
Regenerated the root mirror with the repo's own script (
node scripts/sync-readme.mjs), restoring byte-for-byte parity so--checkpasses. No hand-editing of the generated file. The 4 removed lines (Rust sibling callout) were never in the canonical source; if that callout is wanted, it should be added topackage/README.mdand re-synced in a separate change.Verified locally:
node scripts/sync-readme.mjs --checkreports in-sync.Generated by Claude Code