mongodb / docs-realm

Realm Database SDK documentation
https://www.mongodb.com/docs/realm/
46 stars 88 forks source link

(DOCSP-39540) Consolidate Partition-Based Sync page #3279

Closed dacharyc closed 5 months ago

dacharyc commented 5 months ago

Pull Request Info - SDK Docs Consolidation

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

Staged Page

Page Source

Note for reviewer: I've intentionally omitted some of the information that is present on some of the source pages. There's a lot of discrepancy between SDK docs re: the write copy API to copy between sync and non-synced realms. Some SDKs say you can use it with Flexible Sync, others say it only works with PBS. I started to include it on the page, but then omitted it. I think we should probably only doc it on the "Configure and Open a Synced Realm" page if it supports Flexible Sync.

The other thing is - Java and .NET have sections about opening a realm online vs. offline. I originally started to add that to this page, but decided it's outside the scope of PBS - it just happens to use PBS examples. We already have examples on the "Configure and Open a Synced Realm" page about opening a realm offline, so I think that content should only live there.

PR Author Checklist

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

Naming

Links and Refs

Content

Reviewer Checklist

As a reviewer, please check these items:

github-actions[bot] commented 5 months ago

Readability for Commit Hash: 3f4931f6800197d04ce8a51a694c0ff3cc9b2a2b

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

Readability scores for changed documents:

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 5 months ago

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

🪵 Logs