Skip to content

docs(react-native): rewrite README - #90

Open
NathanWalker wants to merge 6 commits into
android-react-nativefrom
docs/rn-readme-rewrite
Open

NathanWalker wants to merge 6 commits into
android-react-nativefrom
docs/rn-readme-rewrite

Conversation

@NathanWalker

@NathanWalker NathanWalker commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Note

Squash merge this PR as one docs commit: docs(react-native): rewrite README.

Split out of #77. All README changes from #77 are here instead of in the fix PRs, so the fix PRs don't conflict with each other in the README. Merge this last. It documents behaviour from the PRs below.

Summary

packages/react-native/README.md
├── rewrite for npm readers (install, Expo, usage, UIKit views, Android, building)
├── metadata configuration docs
├── import-time error when the native module is missing      → #82
├── worklets plugin needs { strictGlobal: true }             → #83
├── C enum member names as globals, short names on the enum  → #87
├── $name fallback for package names already taken ($expo)   → #86
├── runOnUI results; objects never cross runtimes           → #88
└── Android behaviour across a JS reload                     → #89

The Android main-thread / view content from #77 (runOnUI, nativeViewHandle, androidContext, NativeScriptUIView on Android) is left out. The Threads section still says those helpers are iOS only.

Evidence

Docs only, no code changes.

Merge Danger

Door: two-way

Blast Radius: docs

If merged before #82, #83, #86, #87, #88 or #89, the README describes behaviour that isn't on the branch yet.

Put requirements and installation first and move the monorepo build
scripts to a closing section. Document that iOS JS-thread globals are
opt-in via init("", { globals: true }), Android release metadata
filtering, and the Android steps of configure and the Expo plugin.
Fix examples that touched UIKit or undefined names off the UI runtime.
@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: bba1a658-0161-43b3-8045-c62444313516

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

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

This branch has not been deployed

No deployments
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