Consolidation Providers and Hooks

osharaf-mdb commented 1 month ago

Pull Request Info - SDK Docs Consolidation

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

Staged Page

Providers & Hooks

Page Source

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:

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

Naming

[x] 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

[x] Create new consolidated SDK ref targets starting with "_sdks-" for relevant sections
[x] 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

netlify[bot] commented 1 month ago

Deploy Preview for device-sdk ready!

Name	Link
Latest commit	a77af233b0b95ac8c0ce8b61fb982f1120e6441f
Latest deploy log	https://app.netlify.com/sites/device-sdk/deploys/66b529181d3e3100099e73e2
Deploy Preview	https://deploy-preview-3356--device-sdk.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions[bot] commented 1 month ago

Readability for Commit Hash: a77af233b0b95ac8c0ce8b61fb982f1120e6441f

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

Readability scores for changed documents:

source/sdk/files/configure-and-open: Grade Level: 6.4, Reading Ease: 68.67

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.

docs-builder-bot commented 1 month ago

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

🪵 Logs

job log: c2b62107b35c35c86f9e4a995d95abb344143578

mongodb / docs-realm