docs: Note the preios setup script #53312
Merged
Conversation
This file contains 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
Without running this command, the iOS app will not successfully build as Pod dependencies will be missing. The `native preios` script is run by the `native ios` script, but it is possible to build the iOS app through other means that do not run `native preios`, e.g. pressing `i` after starting the Metro server via `npm run native start:reset`. Explicitly running `preios` during setup will help avoid confusing errors.
dcalhoun
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
dcalhoun
added
[Type] Developer Documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
Document the need to run
npm run native preioswhen setting up the nativeeditor development environment.
Why?
Without running this command, the iOS app will not successfully build as
Pod dependencies will be missing. The
native preiosscript is run bythe
native iosscript, but it is possible to build the iOS app throughother means that do not run
native preios, e.g. pressingiafterstarting the Metro server via
npm run native start:reset.Explicitly running
preiosduring setup will help avoid confusingerrors.
How?
Add a note to the getting started documentation.
Testing Instructions
n/a
Testing Instructions for Keyboard
n/a
Screenshots or screencast
n/a