docs(native): point the three native runbooks at mono (main) - #2540
Conversation
The Android, iOS and demo-mode runbooks were consolidated into mono at engineering/native/ so there is one source of truth. The copies here had already drifted and now state wrong facts (Capgo deploy triggers, a secret name that no longer exists, the wrong Sumsub plugin package), so a reader landing on them gets misled. Kept as pointers rather than deleted because three files in the release pipeline still reference these paths. Paths are repo-relative, not github.com URLs, so they also resolve for readers who only have a partial copy of mono.
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThree native documentation pages were shortened to point readers to canonical demo-mode, iOS release, Android release, and local development runbooks in the mono repo. ChangesNative runbook consolidation
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
🧪 UI test report — ✅ all greenSuites
📊 Coverage (unit)
⏱ 10 slowest test cases
|
|
@coderabbitai review |
✅ Action performedReview finished.
|
Summary
The three native runbooks were consolidated into the mono repo under
engineering/native/so there is one source of truth. The copies that stayed inpeanut-ui/docs/have since drifted and now state facts that are wrong:Anyone landing on them today gets misled. This replaces each body with a ~4-line pointer to the mono location.
docs/NATIVE-RELEASE.mdengineering/native/release-android.md(+ local dev / emulator setup →engineering/native/agency-onboarding.md)docs/NATIVE-RELEASE-IOS.mdengineering/native/release-ios.mddocs/DEMO-MODE.mdengineering/native/demo-mode.mdDesign notes / accepted trade-offs
.github/workflows/android-release.yml,.github/workflows/ios-release.yml,scripts/native-release.sh. They are deliberately left untouched and resolve fine through the pointer files. Deleting the docs would break those references; that cleanup is a separate follow-up if anyone wants it.engineering/native/release-android.mdis correct in both cases.Risks / breaking changes
None. Markdown only — no runtime, no imports, no build graph. No cross-repo action needed.
QA
git diff --statis 3 markdown files, +7 / −568. Local gate: prettier ✅ · jest 1847/1847 ✅ · typecheck unaffected (no TS reads.md).Screenshots: N/A (no visible change).
mainalready fails eslint (devcarries the #2447 eslint-cleanup thatmainhas not received yet). Counts are identical to the baseline, so this PR changes nothing:origin/mainbaseline (run 30343759840)Every reported error is in a
.ts/.tsxfile; this diff contains only.md. The companion PR #2539 (basedev) passes eslint outright, which independently confirms the change introduces no lint errors.Companion PR
This is the
mainhalf. Bothdevandmaincarry the stale copies byte-identically, so the same commit is cherry-picked onto each branch. ThedevPR is #2539.Routed as a direct PR to
mainrather than waiting on thedev→mainrelease train, because the train would drag every unrelated commit currently ondevinto production. Docs-only, zero runtime — the cherry-pick is byte-identical to #2539, so the next release train merges without conflict.