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

Update Expo references in React Native docs #3058

Merged
merged 6 commits into from
Oct 20, 2023

Conversation

krollins-mdb
Copy link
Collaborator

@krollins-mdb krollins-mdb commented Oct 19, 2023

Pull Request Info

We got some docs feedback about Expo. We weren't giving enough indication of where Expo users should look for information.

This PR shuffles some content and provides better sign posting for Expo users.

Staged Changes

Review Guidelines

REVIEWING.md

Animal Wearing a Hat

- Move version info to bootstrap page
@github-actions
Copy link

github-actions bot commented Oct 19, 2023

Readability for Commit Hash: d07f2af

You can see any previous Readability scores (if they exist) by looking
at the comment's history.

Readability scores for changed documents:

  • source/sdk/react-native/use-realm-react: Grade Level: 10.0, Reading Ease: 54.02
  • source/sdk/react-native/bootstrap-with-expo: Grade Level: 12.3, Reading Ease: 48.13
  • source/sdk/react-native/install: Grade Level: 10.2, Reading Ease: 42.68

For Grade Level, aim for 8 or below.

For Reading Ease scores, aim for 60 or above:

Score Difficulty
90-100 Very Easy
80-89 Easy
70-79 Fairly Easy
60-69 Medium
50-59 Fairly Hard
30-49 Hard
0-29 Very Hard

For help improving readability, try Hemingway App.

@krollins-mdb krollins-mdb marked this pull request as ready for review October 19, 2023 20:50
Copy link
Collaborator

@lindseymoore lindseymoore left a comment

Choose a reason for hiding this comment

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

Small comments, LGTM!

the :github:`Realm Expo template <expo/examples/tree/master/with-realm>`.
The Realm Expo template allows you to bootstrap your application with
`Expo <https://docs.expo.dev/>`_ and ``@realm/react`` preconfigured.
Create a New App and add ``@realm/react``
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Create a New App and add ``@realm/react``
Add ``@realm/react`` to a New App

suggestion for consistency's sake.


npm install @realm/react

To use the Realm Expo template, follow the :ref:`Quick Start with Expo
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
To use the Realm Expo template, follow the :ref:`Quick Start with Expo
To create a new app with @realm/react using the Realm Expo template, follow the :ref:`Quick Start with Expo

For clarity that the this quick start will also guide through steps of creating new app with @realm/react.

@krollins-mdb krollins-mdb merged commit cc887f0 into mongodb:master Oct 20, 2023
@docs-builder-bot
Copy link

@krollins-mdb krollins-mdb deleted the update-expo-references branch October 20, 2023 14:36
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.

3 participants