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] "Existing React Native apps" and "Existing native apps" docs groups #27608

Merged
merged 7 commits into from Apr 3, 2024

Conversation

brentvatne
Copy link
Member

@brentvatne brentvatne commented Mar 12, 2024

  • Rename "Bare React Native" to "Existing React Native apps"
  • Stopped telling people how to initialize bare apps there.
  • We should do more work to integrate instructions for how to configure libraries for bare apps within the docs sections for the respective tools, eg: dev client and updates shouldn't delegate to a specific section for this. Instead, the docs within this "Existing React Native apps" section should explain why you would want to use the tools in that context and tell people anything they might need to know beyond what is explained in the normal bare setup instructions (that we then link to).
  • Cleaned up a bunch of the docs within the "Existing React Native apps" section.
  • Moved the guide about working around running your app in Expo Go even if it has custom native code. We don't want to encourage this, folks should use dev builds.
  • Add "Existing native apps" section. This includes our first pass at explaining how to use Expo modules in a "brownfield" app context. I expect we will extend this section more, for now it's more of a stake in the ground with appropriate warnings.

@brentvatne brentvatne changed the title [docs] Rough outline for brownfield docs [docs] Brownfield docs Mar 12, 2024
@expo-bot expo-bot added the bot: passed checks ExpoBot has nothing to complain about label Mar 12, 2024
@brentvatne brentvatne changed the title [docs] Brownfield docs [docs] "Existing React Native apps" and "Existing native apps" docs groups Apr 3, 2024
@brentvatne brentvatne marked this pull request as ready for review April 3, 2024 01:08
@expo-bot
Copy link
Collaborator

expo-bot commented Apr 3, 2024

📘 Your docs preview website is ready!

Copy link
Member

@ide ide left a comment

Choose a reason for hiding this comment

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

In addition to the inline comments, I think it would be good to order Kotlin before Swift since we typically order Android before iOS. That way the programming languages line up (but also K does come before S, but that's not the motivation).

docs/pages/bare/install-dev-builds-in-bare.mdx Outdated Show resolved Hide resolved
docs/pages/bare/install-dev-builds-in-bare.mdx Outdated Show resolved Hide resolved
docs/pages/bare/install-dev-builds-in-bare.mdx Outdated Show resolved Hide resolved
docs/pages/bare/installing-updates.mdx Outdated Show resolved Hide resolved
docs/pages/brownfield/overview.mdx Outdated Show resolved Hide resolved
docs/pages/brownfield/installing-expo-modules.mdx Outdated Show resolved Hide resolved
docs/pages/brownfield/installing-expo-modules.mdx Outdated Show resolved Hide resolved
/>
</Step>

## Configure your Android app
Copy link
Member

Choose a reason for hiding this comment

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

Suggestion: move this whole section above "Configure your iOS app" to match the (Android, iOS) ordering we use elsewhere mostly.

docs/pages/brownfield/installing-expo-modules.mdx Outdated Show resolved Hide resolved
</Step>

<Step label="3">
If you have your own class extending `Application`, you can add the following to it:
Copy link
Member

Choose a reason for hiding this comment

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

Explain why you'd want to add it. The phrasing ("you can") says that you have the choice but doesn't explain why you'd want to make that choice or how to decide.

brentvatne and others added 2 commits April 2, 2024 21:47
Co-authored-by: James Ide <ide@users.noreply.github.com>
@brentvatne brentvatne merged commit 3b39d79 into main Apr 3, 2024
7 checks passed
@brentvatne brentvatne deleted the brownfield-docs branch April 3, 2024 05:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: passed checks ExpoBot has nothing to complain about preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants