Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(rn): add callouts for expo tsconfig and deployment targets #1304

Merged
merged 1 commit into from
Jan 28, 2025

Conversation

moldy530
Copy link
Collaborator

@moldy530 moldy530 commented Jan 28, 2025

Pull Request Checklist


PR-Codex overview

This PR primarily updates the documentation for the React Native Signer package, emphasizing the prerequisites, setup instructions, and compatibility with React Native's new architecture. It introduces a new prerequisites.mdx file and integrates its content into various existing documentation files.

Detailed summary

  • Added a new section ## Pre-requisites in prerequisites.mdx listing requirements for the React Native Signer.
  • Removed caution warnings about the Alchemy Signer being in Alpha from multiple files.
  • Integrated a Snippet component to include prerequisite information in overview.mdx, setup-guide.mdx, getting-started-rn-bare.mdx, and getting-started-expo.mdx.
  • Updated setup instructions to clarify the need for iOS minimum deployment target of 17.0.
  • Revised installation commands for clarity and added necessary dependencies.
  • Improved formatting and organization of the getting started sections across various files.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

vercel bot commented Jan 28, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
aa-sdk-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 28, 2025 11:28pm
aa-sdk-ui-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 28, 2025 11:28pm

Copy link
Collaborator Author

moldy530 commented Jan 28, 2025

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more


How to use the Graphite Merge Queue

Add the label graphite-merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link
Collaborator

@iykazrji iykazrji left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@moldy530 , Just a comment about setting the deployment target properly without editing the native files directly.

Comment on lines 186 to 171
After running the above command for iOS, you need to update the `ios/Podfile.properties.json` to target iOS minimum version of 17.0
```json
{
// ...other settings
"ios.deploymentTarget": "17.0"
}
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So with the Expo prebuild flow, we don't want to be touching the generated native files (i.e files in the ios / android folders) cause they would get re-generated anytime the user does a Prebuild and our changes would be lost.

In this case we should tell the user to use expo-build-properties to configure the deploymentTarget.

This updates the native properties on either platform using a Config Plugin which means anytime a Prebuild happens, Expo knows to read update the build config to whatever we set here.

The docs are here https://docs.expo.dev/versions/latest/sdk/build-properties/

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh lemme try that

Copy link
Collaborator

@iykazrji iykazrji left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

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.

2 participants