(DOCSP-31536) Update RN quick start #3141

krollins-mdb · 2024-01-05T16:53:31Z

Pull Request Info

Jira ticket: https://jira.mongodb.org/browse/DOCSP-31536

Quick Start
- Migrated the quick start examples from the legacy test suite to the v12 test suite.
- Updated examples to use the latest @realm/react conventions.
- Wrote new tests for the new test app components.
- Refactored the tutorial content where needed.

Reminder Checklist

Before merging your PR, make sure to check a few things.

Did you tag pages appropriately?
- genre
- meta.keywords
- meta.description
Describe your PR's changes in the Release Notes section
Create a Jira ticket for related docs-app-services work, if any

Release Notes

React Native SDK
- React Native/Quick Start: Rewrite the Quick Start to use the latest @realm/react conventions and Realm.js v12 features.

Review Guidelines

REVIEWING.md

Animal Wearing a Hat

- Create examples - Generate snippets - Update quickstart content

- Create - Update - Delete

- Update sync content - Reorganize a bit of content

github-actions · 2024-01-05T16:54:47Z

Readability for Commit Hash: 545a3c2

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/quick-start: Grade Level: 6.5, Reading Ease: 68.57

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.

- Regenerate code snippets

cbullinger

Nice work!

examples/react-native/v12/TestApp/src/components/quickstart/nonsync/RealmWrapper.test.tsx

cbullinger · 2024-01-09T13:32:49Z

source/examples/generated/react-native/v12/Read.snippet.qs-find-sort-filter.tsx.rst

+   import {useQuery} from '@realm/react';
+   import {Profile} from '../../models';
+
+   export const Read = () => {


cbullinger · 2024-01-09T13:36:51Z

source/sdk/react-native/quick-start.txt

-         :emphasize-lines: 41-47, 54-60
+Instead, you can use :js-sdk:`Realm.objects <classes/Realm-1.html#objects>` for
+collections or :js-sdk:`Realm.objectForPrimaryKey 
+<classes/Realm-1.html#objectForPrimaryKey>` a single object.


do we want to link to the Read page?

Yes, we should! Thanks for suggesting.

source/sdk/react-native/quick-start.txt

cbullinger · 2024-01-09T13:43:35Z

source/sdk/react-native/quick-start.txt

+#. Pass your object models to the ``schema`` prop.
+#. Add other :realm-react-sdk:`Configuration object <types/Realm.BaseConfiguration.html>` 
+   properties as props to ``RealmProvider``. For example, make the realm read
+   only or add Atlas Device Sync.


For example, make the realm read only or <something else that isn't Device Sync>.?
IDK why this is bugging me, but maybe omit since "adding Device Sync" isn't equivalent to passing a read-only parameter?

Yeah, looking at it now, I don't think this sentence adds much. I'll remove the whole thing.

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

docs-builder-bot · 2024-01-10T18:13:43Z

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/

🪵 Logs

job log: 2195efb9352ba8a062b56b9f4171208fcd325fae

krollins-mdb added 6 commits December 18, 2023 09:07

Initial

cf72783

Merge branch 'master' into DOCSP-31536

45f3978

New CRUD components in place

6e66107

Update configure realm and read operations

1005383

- Create examples - Generate snippets - Update quickstart content

New examples and edits for these sections:

99f5a11

- Create - Update - Delete

- Add sync example

9c250b5

- Update sync content - Reorganize a bit of content

krollins-mdb added 5 commits January 5, 2024 13:42

Write initial test for non-sync wrapper

8a22804

Break out monolith test

8949f43

- Add sync tests

39910fe

- Regenerate code snippets

Add snooty tags

f7cb8e5

Fix bluehawk syntax error

cf68f04

krollins-mdb marked this pull request as ready for review January 8, 2024 15:20

cbullinger approved these changes Jan 9, 2024

View reviewed changes

krollins-mdb and others added 2 commits January 9, 2024 13:38

Apply suggestions from code review

0d26337

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

Apply feedback from Cory

545a3c2

krollins-mdb merged commit 2195efb into mongodb:master Jan 10, 2024
5 of 6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(DOCSP-31536) Update RN quick start #3141

(DOCSP-31536) Update RN quick start #3141

krollins-mdb commented Jan 5, 2024 •

edited

Loading

github-actions bot commented Jan 5, 2024 •

edited

Loading

cbullinger left a comment

cbullinger Jan 9, 2024

cbullinger Jan 9, 2024

krollins-mdb Jan 9, 2024

cbullinger Jan 9, 2024

krollins-mdb Jan 9, 2024

docs-builder-bot commented Jan 10, 2024

(DOCSP-31536) Update RN quick start #3141

(DOCSP-31536) Update RN quick start #3141

Conversation

krollins-mdb commented Jan 5, 2024 • edited Loading

Pull Request Info

Reminder Checklist

Release Notes

Review Guidelines

Animal Wearing a Hat

github-actions bot commented Jan 5, 2024 • edited Loading

cbullinger left a comment

Choose a reason for hiding this comment

cbullinger Jan 9, 2024

Choose a reason for hiding this comment

cbullinger Jan 9, 2024

Choose a reason for hiding this comment

krollins-mdb Jan 9, 2024

Choose a reason for hiding this comment

cbullinger Jan 9, 2024

Choose a reason for hiding this comment

krollins-mdb Jan 9, 2024

Choose a reason for hiding this comment

docs-builder-bot commented Jan 10, 2024

🪵 Logs

krollins-mdb commented Jan 5, 2024 •

edited

Loading

github-actions bot commented Jan 5, 2024 •

edited

Loading