Skip to content

docs(native): point the three native runbooks at mono (main) - #2540

Merged
Hugo0 merged 1 commit into
mainfrom
docs/native-runbook-pointers-main
Jul 28, 2026
Merged

docs(native): point the three native runbooks at mono (main)#2540
Hugo0 merged 1 commit into
mainfrom
docs/native-runbook-pointers-main

Conversation

@Hugo0

@Hugo0 Hugo0 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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 in peanut-ui/docs/ have since drifted and now state facts that are wrong:

  • the wrong Capgo deploy triggers,
  • a CI secret name that no longer exists,
  • the wrong Sumsub plugin package.

Anyone landing on them today gets misled. This replaces each body with a ~4-line pointer to the mono location.

File Now points at
docs/NATIVE-RELEASE.md engineering/native/release-android.md (+ local dev / emulator setup → engineering/native/agency-onboarding.md)
docs/NATIVE-RELEASE-IOS.md engineering/native/release-ios.md
docs/DEMO-MODE.md engineering/native/demo-mode.md

Design notes / accepted trade-offs

  • Pointers, not deletions. Three files in the release pipeline still reference these paths — .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.
  • Repo-relative paths, not github.com URLs. Some readers have a partial copy of mono rather than the full repository, so a github.com link would not resolve for them, while engineering/native/release-android.md is 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 --stat is 3 markdown files, +7 / −568. Local gate: prettier ✅ · jest 1847/1847 ✅ · typecheck unaffected (no TS reads .md).

Screenshots: N/A (no visible change).

⚠️ eslint is red — pre-existing, not worsened

main already fails eslint (dev carries the #2447 eslint-cleanup that main has not received yet). Counts are identical to the baseline, so this PR changes nothing:

problems errors warnings
origin/main baseline (run 30343759840) 979 825 154
this branch (run 30346601373) 979 825 154

Every reported error is in a .ts/.tsx file; this diff contains only .md. The companion PR #2539 (base dev) passes eslint outright, which independently confirms the change introduces no lint errors.

Companion PR

This is the main half. Both dev and main carry the stale copies byte-identically, so the same commit is cherry-picked onto each branch. The dev PR is #2539.

Routed as a direct PR to main rather than waiting on the devmain release train, because the train would drag every unrelated commit currently on dev into production. Docs-only, zero runtime — the cherry-pick is byte-identical to #2539, so the next release train merges without conflict.

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.
@cursor

cursor Bot commented Jul 28, 2026

Copy link
Copy Markdown

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.

@vercel

vercel Bot commented Jul 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
peanut-wallet Ready Ready Preview, Comment Jul 28, 2026 9:32am

Request Review

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Three native documentation pages were shortened to point readers to canonical demo-mode, iOS release, Android release, and local development runbooks in the mono repo.

Changes

Native runbook consolidation

Layer / File(s) Summary
Canonical runbook notices
docs/DEMO-MODE.md, docs/NATIVE-RELEASE-IOS.md, docs/NATIVE-RELEASE.md
Replaced detailed native documentation with notices linking to the corresponding mono-repo runbooks and setup guide.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: innolope-dev

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: redirecting three native runbooks to their mono-repo sources.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/native-runbook-pointers-main

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

🧪 UI test report — ✅ all green

Suites

  • unit: 2180 ran, 0 failed, 0 skipped, 37.8s

📊 Coverage (unit)

metric %
statements 61.1%
branches 44.7%
functions 50.5%
lines 61.5%
⏱ 10 slowest test cases
time test
3.7s src/components/Card/share-asset/__tests__/shareAssetLayout.test.ts › never places two stickers in heavy overlap (broad seed sweep)
1.4s src/utils/__tests__/demo-api.test.ts › isDemoMode() is false when not running under Capacitor
0.5s src/components/Card/share-asset/__tests__/shareAssetLayout.test.ts › every sticker stays within canvas at any count
0.4s src/app/actions/__tests__/api-headers.test.ts › should include Content-Type in validateInviteCode
0.3s src/app/actions/__tests__/api-headers-extended.test.ts › should not include apiKey in validateInviteCode body
0.3s src/app/(mobile-ui)/withdraw/__tests__/withdraw-states.test.tsx › Bank withdrawal keeps the $1 minimum for sub-$1 amounts
0.3s src/components/Card/share-asset/__tests__/shareAssetLayout.test.ts › keeps stickers off the username pill (final pass respects the keep-out)
0.2s src/utils/__tests__/demo-balance.test.ts › auto-refills a wallet older than the TTL on cold start
0.2s src/utils/__tests__/url.utils.test.ts › uses the public BASE_URL in Capacitor, not the localhost WebView origin
0.2s src/utils/__tests__/demo-balance.test.ts › keeps a spent-down balance across a cold start within the TTL
📍 Inline annotations are in the **Unit test report** check above. Coverage artifact: `coverage-unit`. Generated by `.github/workflows/tests.yml`.

@Hugo0

Hugo0 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@Hugo0
Hugo0 marked this pull request as ready for review July 28, 2026 09:47
@Hugo0
Hugo0 merged commit 1ed7b2f into main Jul 28, 2026
24 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant