Consolidation Providers and Hooks

[osharaf-mdb]

Pull Request Info - SDK Docs Consolidation

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

Staged Page

• Providers & Hooks

Page Source

• RealmProvider (@realm/react)
• AppProvider (@realm/react)
• UserProvider (@realm/react)

Note
This PR is built off a previous PR, linked here. The previous PR had feedback from the original draft and the second draft after that. The feedback from that second draft was then implemented to get what is seen here.

PR Author Checklist

Before requesting a review for your PR, please check these items:

• Open the PR against the feature-consolidated-sdk-docs branch instead of master
• Tag the consolidated page for:
  • genre
  • meta.keywords
  • meta.description

Naming

• Update Realm naming and the language around persistence layer/local/device per this document
• Include .rst files comply with the naming guidelines

Links and Refs

• Create new consolidated SDK ref targets starting with "_sdks-" for relevant sections
• Remove or update any SDK-specific refs to use the new consolidated SDK ref targets
• Update any Kotlin API links to use the new Kotlin SDK roles

Content

• Shared code boxes have snippets or placeholders for all 9 languages
• API description sections have API details or a generic placeholder for all 9 languages
• Check related pages for relevant content to include
• Create a ticket for missing examples in each relevant SDK: Consolidation Gaps epic

Reviewer Checklist

As a reviewer, please check these items:

• Shared code example boxes contain language-specific snippets or placeholders for every language
• API reference details contain working API reference links or generic content
• Realm naming/language has been updated
• All relevant content from individual SDK pages is present on the consolidated page

[krollins-mdb]

Nice job, @osharaf-mdb! Thanks for all of the hard work you put into this page! LGTM. 🎊

There are some build errors you should look at though. See the Netlify logs here: https://app.netlify.com/sites/device-sdk/deploys/66b1acaec55e1b00087de096#L405-L423

[gagik]

Great job, great improvements! Some minor comments you could consider:

[kneth]

Nice work! I have added a few comments and suggestions as you can take in if you want

[kneth]

Do we want to mention the scenarios where false is a good value?

[dacharyc]

Nice work, Omar! I love it.

I'm requesting changes for a couple of typos I've called out here - we should definitely fix those before merging. I've also left feedback about some more subjective changes, but feel free to take or leave those suggestions - if it's not a typo, it's not blocking.

[dacharyc]

I'm generally ok with the wrapping, but this method where we're wrapping one character just looks really odd to me. I notice a few places below we're wrapping 1, 2, or 3 characters.

I notice some of the code blocks in the table require scrolling even at the current table width. It seems like the // user defined function text is what's requiring most of the code blocks to scroll. I wonder if we can remove that comment - maybe move the comment to the line above or below, or mention above the table that the getAPIKey or getToken functions are user-defined. IF we can remove this user-defined function text, I think we can make the third column a little narrower and give this first column a little more space so we're not wrapping single characters.

[dacharyc]

LGTM - awesome work, @osharaf-mdb ! 🎉 🚀

[docs-builder-bot]

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/feature-consolidated-sdk-docs/

🪵 Logs

• job log: c2b62107b35c35c86f9e4a995d95abb344143578