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

Feature Branch for Consolidated SDK Docs #3255

Open
wants to merge 66 commits into
base: master
Choose a base branch
from

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented May 15, 2024

Pull Request Info

This is the feature branch for us to cut page-level branches from and merge to for the SDK docs consolidation project.

DO NOT MERGE until the consolidate SDK docs Jira epic is complete: https://jira.mongodb.org/browse/DOCSP-39460

Copy link

github-actions bot commented May 15, 2024

Readability for Commit Hash: db143e6

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

Readability scores for changed documents:

  • source/sdk/crud: Grade Level: 14.6, Reading Ease: 31.21
  • source/sdk/test-and-debug: Grade Level: 17.4, Reading Ease: -2.98
  • source/sdk/release-notes: Grade Level: 14.8, Reading Ease: -1.49
  • source/sdk/sync: Grade Level: 26.2, Reading Ease: -31.23
  • source/sdk/install: Grade Level: 7.4, Reading Ease: 49.99
  • source/sdk/users: Grade Level: 29.9, Reading Ease: -67.95
  • source/sdk/serialization: Grade Level: 16.6, Reading Ease: -6.36
  • source/sdk/telemetry: Grade Level: 8.4, Reading Ease: 36.62
  • source/sdk/react-to-changes: Grade Level: 10.0, Reading Ease: 32.56
  • source/sdk/live-frozen-objects: Grade Level: 8.6, Reading Ease: 57.77
  • source/sdk/api-reference: Grade Level: 20.5, Reading Ease: -43.29
  • source/sdk/model-data: Grade Level: 24.5, Reading Ease: -42.91
  • source/sdk/files: Grade Level: 20.7, Reading Ease: -11.61
  • source/sdk/quick-start: Grade Level: 4.1, Reading Ease: 80.28
  • source/sdk/atlas: Grade Level: 18.6, Reading Ease: -6.02
  • source/sdk/model-data/object-models: Grade Level: 5.9, Reading Ease: 64.67
  • source/sdk/model-data/model-data-device-sync: Grade Level: 7.0, Reading Ease: 56.42
  • source/sdk/model-data/relationships: Grade Level: 14.3, Reading Ease: 10.56
  • source/sdk/model-data/change-object-model: Grade Level: 8.0, Reading Ease: 48.47
  • source/sdk/model-data/supported-types: Grade Level: 10.0, Reading Ease: 37.98
  • source/sdk/files/bundle-file: Grade Level: 2.9, Reading Ease: 83.32
  • source/sdk/files/configure-and-open: Grade Level: 7.7, Reading Ease: 65.32
  • source/sdk/files/delete-file: Grade Level: 2.9, Reading Ease: 83.32
  • source/sdk/files/reduce-file-size: Grade Level: 5.2, Reading Ease: 66.4
  • source/sdk/files/encrypt-file: Grade Level: 6.2, Reading Ease: 58.45
  • source/sdk/atlas/access-mongodb: Grade Level: 8.0, Reading Ease: 53.88
  • source/sdk/atlas/connect: Grade Level: 6.0, Reading Ease: 64.37
  • source/sdk/atlas/call-function: Grade Level: 4.3, Reading Ease: 74.35
  • source/sdk/crud/query-engines: Grade Level: 19.0, Reading Ease: -7.04
  • source/sdk/crud/update: Grade Level: 11.1, Reading Ease: 34.93
  • source/sdk/crud/threading: Grade Level: 8.4, Reading Ease: 36.62
  • source/sdk/crud/delete: Grade Level: 9.6, Reading Ease: 44.41
  • source/sdk/crud/create: Grade Level: 8.8, Reading Ease: 57.27
  • source/sdk/crud/read: Grade Level: 8.8, Reading Ease: 51.85
  • source/sdk/crud/query-engines/filter-data-java-sdk: Grade Level: 8.8, Reading Ease: 46.44
  • source/sdk/crud/query-engines/realm-query-language: Grade Level: 8.2, Reading Ease: 58.58
  • source/sdk/crud/query-engines/filter-data-swift-sdk: Grade Level: 4.4, Reading Ease: 79.26
  • source/sdk/crud/query-engines/filter-data-linq: Grade Level: 4.1, Reading Ease: 74.86
  • source/sdk/users/custom-user-data: Grade Level: 10.2, Reading Ease: 32.05
  • source/sdk/users/authenticate-users: Grade Level: 12.3, Reading Ease: 21.06
  • source/sdk/users/multi-user-applications: Grade Level: 15.9, Reading Ease: -4.33
  • source/sdk/users/manage-email-password-users: Grade Level: 11.3, Reading Ease: 23.59
  • source/sdk/users/create-and-delete-users: Grade Level: 1.3, Reading Ease: 92.8
  • source/sdk/users/user-metadata: Grade Level: 12.3, Reading Ease: 21.06
  • source/sdk/users/manage-user-api-keys: Grade Level: 8.2, Reading Ease: 47.96
  • source/sdk/users/link-user-identities: Grade Level: 11.3, Reading Ease: 23.59
  • source/sdk/test-and-debug/troubleshoot: Grade Level: 15.1, Reading Ease: 3.12
  • source/sdk/test-and-debug/log: Grade Level: 10.7, Reading Ease: 30.53
  • source/sdk/test-and-debug/test: Grade Level: 10.7, Reading Ease: 30.53
  • source/sdk/sync/event-library: Grade Level: 6.9, Reading Ease: 67.35
  • source/sdk/sync/add-sync-to-app: Grade Level: 2.9, Reading Ease: 88.74
  • source/sdk/sync/manage-sync-sessions: Grade Level: 9.0, Reading Ease: 40.51
  • source/sdk/sync/partition-based-sync: Grade Level: 12.3, Reading Ease: 21.06
  • source/sdk/sync/manage-sync-subscriptions: Grade Level: 12.7, Reading Ease: 14.63
  • source/sdk/sync/write-to-synced-database: Grade Level: 5.2, Reading Ease: 71.82
  • source/sdk/sync/configure-and-open-synced-database: Grade Level: 7.2, Reading Ease: 55.91
  • source/sdk/sync/stream-data-to-atlas: Grade Level: 10.4, Reading Ease: 31.55
  • source/sdk/sync/handle-sync-errors: Grade Level: 6.2, Reading Ease: 58.45

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
Copy link

docs-builder-bot commented May 15, 2024

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

🪵 Logs

dacharyc and others added 9 commits May 20, 2024 13:23
## Pull Request Info

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

- [Connect to App Services
Backend](https://preview-mongodblindseymoore.gatsbyjs.io/realm/DOCSP-39161/sdk/dotnet/app-services/connect-to-app-services-backend/)

- Note: Commented out failing tests. Fixing them will be a part of this
ticket: https://jira.mongodb.org/browse/DOCSP-39638.

### Reminder Checklist

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

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

### Release Notes

<!--
- **Kotlin** SDK
- Realm/Manage Realm Files/Encrypt a Realm: Add information on
encryption for
    local and synced realms.
-->

- .NET SDK
- Application Services/Connect to an App Services App: Add a section on
updating the base URL during runtime.

### Review Guidelines


[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)

---------

Co-authored-by: MongoCaleb <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Stream Data to
Atlas](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39539/sdk/sync/stream-data-to-atlas/):
Draft consolidated page

*Page Source*

- [C++: Stream Data to
Atlas](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/sync/stream-data-to-atlas/)
- [Flutter: Stream Data to
Atlas](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/sync/stream-data-to-atlas/)
- [Kotlin: Stream Data to
Atlas](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/sync/stream-data-to-atlas/)
- [.NET: Stream Data to
Atlas](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/sync/asymmetric-sync/)
- [Node.js: Stream Data to
Atlas](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/sync/stream-data-to-atlas/)
- [Swift: Stream Data to
Atlas](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/sync/stream-data-to-atlas/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] Shared code boxes have snippets or placeholders for all 9
languages
- [x] API description sections have API details or a generic placeholder
for all 9 languages
- [x] Check related pages for relevant content to include
- [x] 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

---------

Co-authored-by: lindseymoore <[email protected]>
Co-authored-by: MongoCaleb <[email protected]>
Co-authored-by: cbullinger <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Partition-Based
Sync](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39540/sdk/sync/partition-based-sync/)

*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.

- [Partition-Based Sync -
Java](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/sync/partition-based-sync/)
- [Partition-Based Sync -
Kotlin](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/sync/partition-based-sync/)
- [Partition-Based Sync -
.NET](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/sync/partition-based-sync/)
- [Partition-Based Sync -
Node.js](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/sync/partition-based-sync/)
- [Partition-Based Sync -
Swift](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/sync/partition-based-sync/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

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

---------

Co-authored-by: cbullinger <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Quick
Start](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39501/sdk/quick-start/)
- [SwiftUI Quick
Start](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39501/frameworks/swiftui/quick-start/):
Existing content ported over with Realm naming and ref updates
- [Flutter Quick
Start](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39501/frameworks/flutter/quick-start/):
Move existing Flutter-specific content out of quick start to this
relevant section
- [Unity Quick
Start](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39501/platforms/unity/):
Existing content ported over with Realm naming and ref updates

Adding a note here to capture this in the PR record:
- Product has made the call to remove Java SDK info from our "getting
started" content (here and the Install page), so I've removed the Java
and Kotlin (Java SDK) examples from the consolidated quick start page.
- Based on relatively low usage of the Java SDK Quick Start with
LiveData page, and the need to update it to show Kotlin SDK or at the
very least not Partition-Based Sync, I've checked with engineering and
product and am removing this page from the docs. It doesn't seem
worthwhile to continue to incur the maintenance cost.

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++ Quick
Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/quick-start/)
- [Flutter Quick
Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/quick-start/)
- [Flutter Install
Page](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/install/)
- [Java Local Quick
Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/quick-starts/quick-start-local/)
- [Java Sync Quick
Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/quick-starts/quick-start-sync/)
- [Java Quick Start with Live
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/quick-starts/livedata/)
- [Kotlin Quick
Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/quick-start/)
- [.NET Quick
Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/quick-start/)
- [.NET SDK/Quick Start for
Unity](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/unity/)
- [Node.js Quick
Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/quick-start/)
- [Swift Quick
Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/quick-start/)
- [SwiftUI Quick
Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/swiftui-tutorial/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] Shared code boxes have snippets or placeholders for all 9
languages
- [x] API description sections have API details or a generic placeholder
for all 9 languages
- [x] Check related pages for relevant content to include
- [x] 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

---------

Co-authored-by: cbullinger <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Create, Delete, and Remove
Users](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39525/sdk/users/create-and-delete-users/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [Flutter: Delete a
User](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/users/delete-user/)
- [Java: Create and Delete
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/users/create-delete-users/)
- [Kotlin: Delete
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/users/delete-users/)
- [.NET: Create and Delete
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/manage-users/create-and-delete-users/)
- [Node.js: Create and Delete
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/users/create-delete-users/)
- [Swift: Create and Delete
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/users/create-and-delete-users/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

- [x] Shared code example boxes contain language-specific snippets or
placeholders for every language
- [x] API reference details contain working API reference links or
generic content
- [x] Realm naming/language has been updated
- [x] All relevant content from individual SDK pages is present on the
consolidated page
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Authenticate
Users](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39526/sdk/users/authenticate-users/)
- [Manage User
Tokens](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39526/sdk/users/manage-user-tokens/):
New page that moves the user access token info off the "Authenticate"
page. This is currently [a separate page in
Flutter](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/users/access-token/).
As devs shouldn't have to handle this manually for most use cases, _and_
the OTP is getting super long, I thought it made sense to move the info
off to a separate page.

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++: Authenticate
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/users/authenticate-users/)
- [Flutter: Authenticate
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/users/authenticate/)
- [Flutter: Get an Access
Token](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/users/access-token/)
- [Java: Authenticate
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/users/authenticate-users/)
- [Kotlin: Autenticate
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/users/authenticate-users/)
- [.NET: Authenticate
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/manage-users/authenticate/)
- [Node.js: Authenticate
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/users/authenticate-users/)
- [Swift: Authenticate
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/users/authenticate-users/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] Shared code boxes have snippets or placeholders for all 9
languages
- [x] API description sections have API details or a generic placeholder
for all 9 languages
- [x] Check related pages for relevant content to include
- [x] 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

---------

Co-authored-by: Kyle Rollins <[email protected]>
Moved the client reset handling details off the page so we can merge
this PR. When PR #8109 in the realm-swift repository gets released, we
can re-test and add the client reset handling details to the page.

- https://jira.mongodb.org/browse/DOCSP-26313

- [Handle Sync
Errors](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-26313/sdk/swift/swiftui/handle-sync-errors/)

If your PR modifies the docs, you might need to also update some
corresponding
pages. Check if completed or N/A.

- [x] Create Jira ticket for corresponding docs-app-services update(s),
if any
- [x] Checked/updated Admin API
- [x] Checked/updated CLI reference

- Swift SDK
- SwiftUI/Handle Sync Errors: New page demonstrating how to set and use
a sync error handler in SwiftUI.

[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
dacharyc and others added 30 commits June 24, 2024 17:30
## Pull Request Info

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

- [Many Pages Across
docs-realm](https://preview-mongodbosharafmdb.gatsbyjs.io/realm/DOCSP-16785-the-the-typo/):
changed "the the" typo and added metadata

### Reminder Checklist

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

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

### Release Notes

- **Across many docs-realm pages**
  - fixed "the the" typo and added meta data

### Review Guidelines


[REVIEWING.md](https://github.com/mongodb/docs-app-services/blob/master/REVIEWING.md)

---------

Co-authored-by: lindseymoore <[email protected]>
Co-authored-by: cbullinger <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

-
[Logging](https://preview-mongodbkrollinsmdb.gatsbyjs.io/realm/DOCSP-39541/sdk/test-and-debug/log/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [Logging - C++
SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/logging/)
- [Logging - Flutter
SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/logging/)
- Added new Logger examples because the current examples no longer work
- [Log Realm Events - Java
SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/test-and-debug/log-realm-events/)
- [Logging - Kotlin
SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/logging/)
- [Logging - .NET
SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/logging/)
- [Logging - Node.js
SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/logging/)
- [Logging - Swift
SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/logging/)
- [Log Realm Events - Java
SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/test-and-debug/log-realm-events/)
- [Set the Sync Client Log Level - C++
SDK](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/sync/log-level/)
- All of the other SDKs' Sync Client Log Level page content will not be
migrated. It's a deprecated feature that makes talking about logging
awkward at best.

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] Shared code boxes have snippets or placeholders for all 9
languages
- [x] API description sections have API details or a generic placeholder
for all 9 languages
- [x] Check related pages for relevant content to include
- [x] 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

---------

Co-authored-by: Dachary <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

New consolidated pages:
- [Create Object
Methods](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39513/sdk/crud/create/create-methods/)
- [Create Object
Types](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39513/sdk/crud/create/create-object-types/)
- [Create Property
Types](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39513/sdk/crud/create/create-property-types/)

Existing pages, ported over to the consolidated IA and updated for
product naming/metadata:
- [Swift
Concurrency](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39513/platforms/apple/swift-concurrency/)
- [Swift Actor
Support](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39513/platforms/apple/use-sdk-with-actors/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++:
Create](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/crud/create/)
- [Flutter:
Create](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/crud/create/)
- [Flutter:
Update](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/crud/update/#upsert-objects):
Upsert
- [Flutter: Data
Types](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/data-types/)
-
[Flutter/Relationships](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/relationships/)
- [Flutter:
Geospatial](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/geospatial/)
- [Java:
Create](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/crud/create/)
- [Java:
Update](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/crud/update/#upsert-an-object):
Upsert
- [Java: Data
Types/Mixed](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/data-types/realmany/)
- [Java: Data
Types/Counters](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/data-types/counters/)
- [Java: Data
Types/Dictionaries](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/data-types/realmdictionary/)
- [Java: Data
Types/Sets](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/data-types/realmset/)
- [Java: Data
Types/Enums](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/data-types/enums/)
- [Java: Data Types/Embedded
Objects](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/data-types/embedded-objects/)
- [Java:
Relationships](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/relationships/)
- [Kotlin:
Create](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/crud/create/)
- [Kotlin:
Update](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/crud/update/#upsert-a-realm-object):
Upsert
- [Kotlin: Model Data/Supported
Types](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/schemas/supported-types/)
- [Kotlin: Model
Data/Geospatial](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/schemas/geospatials/)
- [.NET:
Create](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/crud/create/)
- [.NET: Embedded
Objects](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/embedded-objects/)
- [.NET: Data Types/Field
Types](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/field-types/)
- [.NET: Data
Types/Lists](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/lists/)
- [.NET: Data Types/Realm
Value](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/realm-value/)
- [.NET: Data
Types/Dictionaries](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/dictionaries/)
- [.NET: Data
Types/Sets](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/sets/)
- [.NET: Data
Types/RealmValue](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/realm-value/)
- [.NET: Data
Types/RealmInteger](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/realm-integer/)
- [.NET: Data
Types/Geospatial](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/geospatials/)
- [.NET:
Relationships](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/relationships/)
- [Node.js:
Create](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/crud/create/)
- [Node.js:
Update](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/crud/update/#upsert-an-object):
Upsert
- [Node.js: Data Types/Field
Types](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/field-types/)
- [Node.js: Data
Types/Dictionaries](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/dictionaries/)
- [Node.js: Data
Types/Sets](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/sets/)
- [Node.js: Data
Types/Mixed](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/mixed/)
- [Node.js: Data
Types/UUID](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/uuid/)
- [Node.js: Data Types/Embedded
Objects](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/embedded-objects/)
- [Node.js: Data Types/Geospatial
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/geospatial/)
- [Node.js: Relationships & Embedded
Objects](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/relationships-and-embedded-objects/)
- [Swift:
Create](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/crud/create/)
- [Swift:
Update](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/crud/update/#upsert-an-object):
Upsert
- [Swift: Supported
Types](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/model-data/supported-types/)
- [Swift:
Threading](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/crud/threading/#perform-a-background-write):
Perform a Background Write

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [ ] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)
**Note for Reviewer**: The `.rst` files were named for a single create
page. Having split the create page into 3, the names no longer comply
with the guidelines. As this is around ~140 files, I didn't want to
rename them all - but we may want to consider whether I should go
through the effort, and/or what the naming guidelines look like as the
IA evolves.

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] Shared code boxes have snippets or placeholders for all 9
languages
- [x] API description sections have API details or a generic placeholder
for all 9 languages
- [x] Check related pages for relevant content to include
- [x] 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

---------

Co-authored-by: cbullinger <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Manage Sync
Sessions](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39538/sdk/sync/manage-sync-sessions/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++: Manage Sync
Sessions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/sync/manage-sync-session/)
- [Flutter: Manage Sync
Sessions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/sync/manage-sync-session/)
- [Java: Pause or Resume a Sync
Session](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/sync/pause-resume-sync/)
- [Java: Check the Network
Connection](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/sync/network-connection/)
- [Kotlin: Manage Sync
Session](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/sync/manage-sync-session/)
- [.NET: Suspend or Resume a Sync
Session](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/sync/sync-session/)
- [.NET: Check Upload and Download
Progress](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/sync/sync-progress/)
- [Node.js: Manage a Sync
Session](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/sync/manage-sync-session/)
- [Swift: Manage Sync
Sessions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/sync/sync-session/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

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

---------

Co-authored-by: Kyle Rollins <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Write to a Synced
Database](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39536/sdk/sync/write-to-synced-database/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++: Write to a Synced
Realm](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/sync/write-to-synced-realm/)
- [Flutter: Write Data to a Synced
Realm](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/sync/write-to-synced-realm/)
- [Kotlin: Write to a Synced
Realm](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/sync/write-to-synced-realm/)
- [.NET: Write to a Synced
Realm](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/sync/write-to-synced-realm/)
- [Swift: Write Data to a Synced
Realm](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/sync/write-to-synced-realm/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

- [x] Shared code example boxes contain language-specific snippets or
placeholders for every language
- [x] API reference details contain working API reference links or
generic content
- [ ] Realm naming/language has been updated
- [x] All relevant content from individual SDK pages is present on the
consolidated page
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

-
[Relationships](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39503/sdk/model-data/relationships/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++:
Relationships](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/model-data/relationships/)
- [Flutter:
Relationships](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/relationships/)
- [Java:
Relationships](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/relationships/)
- [Kotlin:
Relationships](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/schemas/relationships/)
- [.NET:
Relationships](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/relationships/)
- [Node.js: Relationships and Embedded
Objects](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/relationships-and-embedded-objects/)
- [Swift:
Relationships](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/model-data/relationships/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

- [x] Shared code example boxes contain language-specific snippets or
placeholders for every language
- [x] API reference details contain working API reference links or
generic content
- [x] Realm naming/language has been updated
- [x] All relevant content from individual SDK pages is present on the
consolidated page
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Define an SDK Object
Model](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39502/sdk/model-data/object-models/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++: Object Types and
Schemas](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/model-data/object-models/)
- [C++: Supported Data
Types](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/model-data/supported-types/)
- [Flutter: Model Data landing
page](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/)
- [Flutter: Define a Realm Object
Schema](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/define-realm-object-schema/)
- [Flutter: Property
Annotations](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/property-annotations/)
- [Java: Model Data landing
page](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/)
- [Java: Define an Object
Model](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/define-a-realm-object-model/)
- [Java: Realm Files Landing page (Realm
Schema)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/realm-files/#realm-schema)
- [Kotlin: Model Data -> Define an Object
Model](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/schemas/define-realm-object-model/)
- [Kotlin: Open & Close a Realm (realm
schema)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/open-and-close-a-realm/)
- [Kotlin: Property
Annotations](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/schemas/property-annotations/)
- [.NET: Define an Object
Model](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/define-object-model/)
- [.NET: Object Types and
Schemas](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/object-models-and-schemas/)
- [.NET: Manually Define a
Schema](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/manual-schema/)
- [.NET: Configure & Open a Realm (Class
Subsets)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/realm-files/realms/#class-subsets)
- [Node.js SDK: Model
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/)
- [Node.js SDK: Define an Object
Model](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/define-a-realm-object-model/)
- [Node.js SDK: Open & Close a Realm
(schemas)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/realm-files/open-and-close-a-realm/)
- [Swift SDK: Model
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/model-data/)
- [Swift SDK: Define an Object
Model](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/model-data/object-models/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

- [x] Shared code example boxes contain language-specific snippets or
placeholders for every language
- [x] API reference details contain working API reference links or
generic content
- [ ] Realm naming/language has been updated
- [x] All relevant content from individual SDK pages is present on the
consolidated page
## Pull Request Info - SDK Docs Consolidation

Jira ticket: https://jira.mongodb.org/browse/DOCSP-3629
- Ports legacy RQL models and tests to v12 test suite
- Generates updated snippets from v12 `.ts` test file

Jira ticket: https://jira.mongodb.org/browse/DOCSP-36618
- Updates Realm Query Language page: 
  - Add language selector
  - Reference new v12 snippets
  - Reorganize sections  

Jira ticket: https://jira.mongodb.org/browse/DOCSP-36265
- Update to indicate support for comparison operators on strings
(expanded lexicographical querying)
- Add example

*Staged Page*

- [Realm Query
Language](https://preview-mongodbcbullinger.gatsbyjs.io/realm/docsp-36298-rql/sdk/crud/query-engines/realm-query-language/)

*Page Source*

- [Realm Query
Language](https://www.mongodb.com/docs/atlas/device-sdks/realm-query-language)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- N/A ~[ ] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles~

#### Content
- [x] Shared code boxes have snippets or placeholders for all 9
languages
> NOTE: Omitted Swift and Objective-C from page
- N/A ~[ ] API description sections have API details or a generic
placeholder for all 9 languages~
- [x] Check related pages for relevant content to include
- [x] 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
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Multi-User
Applications](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39530/sdk/users/multi-user-applications/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [Flutter: Work with Multiple
Users](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/users/multiple-users/)
- [Java: Multi-User
Applications](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/users/multi-user-applications/)
- [Kotlin: Manage Multi-User
Apps](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/users/multi-user-applications/)
- [.NET: Multi-User
Applications](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/manage-users/multi-user-applications/)
- [Node.js: Multi-User
Applications](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/users/multi-user-applications/)
- [Swift: Multi-User
Applications](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/users/multi-user-applications/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

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

---------

Co-authored-by: cbullinger <[email protected]>
…cations updates (#3331)

## Pull Request Info - SDK Docs Consolidation

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

Re: counters, the only info I'm pulling in here is for the "Create"
page. The rest of the Counter info will be incorporated as we work on
other PRs in the consolidation project (for defining a counter property
and updating a counter property).

*Staged Page*

- [Create Property
Types/Counters](https://preview-mongodbdacharyc.gatsbyjs.io/realm/incorporate-counters/sdk/crud/create/create-property-types/#create-a-counter-property):
Add info for JavaScript and TypeScript about creating objects with the
new JS counter type.
- [Manage Sync
Sessions](https://preview-mongodbdacharyc.gatsbyjs.io/realm/incorporate-counters/sdk/sync/manage-sync-sessions/#check-upload-and-download-progress):
Add the .NET example for the new estimate-based progress notifications.

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [.NET: Monitor Sync
Progress](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/sync/sync-progress/#monitor-sync-progress)
- [Node.js:
Counters](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/counters/)

### 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`

### 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
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Call an Atlas
Function](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39523/sdk/atlas/call-function/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++: Call a
Function](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/app-services/call-a-function/)
- [Flutter: Call a
Function](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/app-services/call-function/)
- [Java: Call a
Function](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/app-services/call-a-function/)
- [Kotlin: Call a
Function](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/app-services/call-function/)
- [.NET: Call a
Function](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/app-services/call-a-function/)
- [Node.js: Call a
Function](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/app-services/connect-to-app-services-backend/)
- [Swift: Call a
Function](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/app-services/call-a-function/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

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

---------

Co-authored-by: Kyle Rollins <[email protected]>
…ns (#3343)

## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

-
[Create](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-41466/sdk/crud/create/):
New C# API descriptions for "Create an unmanaged copy of an object" and
"Copy an object to another database" advising developers to use
third-party libraries for this functionality.
## Pull Request Info - SDK Docs Consolidation

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

**Notes for Reviewer**
Only five of the pages listed here should be considered to be in a
"complete" state as of this PR:
- Install
- Apple Privacy Manifest
- Build for tvOS
- Install Atlas Device SDK for Flutter
- Upgrade to Flutter SDK v2.0.0

I moved content off of existing install pages onto a bunch of other
pages, but those pages will get more updates in the future to make them
coherent pages. For now, you only need to confirm that the content got
moved successfully and everything is still working.

Also, noting here that per conversations with the product and
engineering teams, we are intentionally omitting the Java SDK (Java and
Java-Kotlin) from the Install page.

*Staged Page*

-
[Install](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39500/sdk/install/)
- Build for Platforms
-
[Android](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39500/platforms/android/)
-
[Apple](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39500/platforms/apple/)
- [Apple Privacy
Manifest](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39500/platforms/apple/privacy-manifest/)
- [Build for
tvOS](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39500/platforms/apple/tvos/)
-
[IoT](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39500/platforms/iot/)
- [Build for
Unity](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39500/platforms/unity/)
- Build for Frameworks
- [Install Atlas Device SDK for
Flutter](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39500/frameworks/flutter/install/)
- [Upgrade to Flutter v
2.0.0](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39500/hidden-pages/upgrade-to-v2/):
I intentionally orphaned this one in a new `hidden-pages` directory. I
don't think this is necessarily important enough to surface in the ToC,
and we don't have a good pattern for doing that in the new consolidated
world. It's available in the "Upgrade" section, and we could link to it
elsewhere if we come up with a better pattern later.

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++:
Install](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/install/)
- [.NET:
Install](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/install/)
- [Flutter:
Install](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/install/)
- [Flutter:
Troubleshooting](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/troubleshooting/#std-label-flutter-macos-development)
- [Upgrade to SDK
v2.0.0](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/upgrade-to-v2/)
- [Kotlin:
Install](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/install/)
- [Node.js:
Install](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/install/)
- [Swift:
Install](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/install/)
- [Swift: Build for
tvOS](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/realm-files/tvos/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

- [x] Shared code example boxes contain language-specific snippets or
placeholders for every language
- [x] API reference details contain working API reference links or
generic content
- [x] Realm naming/language has been updated
- [x] All relevant content from individual SDK pages is present on the
consolidated page
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Manage Sync
Subscriptions](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39535/sdk/sync/manage-sync-subscriptions/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++: Manage Sync
Subscriptions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/sync/sync-subscriptions/)
- [Flutter: Manage Sync
Subscriptions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/sync/manage-sync-subscriptions/)
- [Java: Manage Sync
Subscriptions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/sync/flexible-sync/)
- [Kotlin: Manage Sync
Subscriptions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/sync/subscribe/)
- [.NET: Manage Flexible Sync
Subscriptions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/sync/flexible-sync/)
- [Node.js: Manage Flexible Sync
Subscriptions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/sync/flexible-sync/)
- [Swift: Manage Flexible Sync
Subscriptions](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/sync/flexible-sync/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

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

---------

Co-authored-by: Kyle Rollins <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Manage Sync
Sessions](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-42045/sdk/sync/manage-sync-sessions/):
Page correctly changes code examples when you switch language tabs.
-
[Help](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-42045/help/):
The Help page was using realm-sdks tab set - I changed it to Drivers tab
set so it would preserve the language selection when the user switched
to the page. I also added a couple of notes related to naming because
there are some naming things here that still reflect the old name, and
we can't change them.
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Custom User
Data](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39527/sdk/users/custom-user-data/)

Note for reviewer: a couple of the API descriptions are missing where we
just don't have an example and there's nothing notable to say. I've
added notes to the follow-up gap tickets to also fill in these API
descriptions when we add examples.

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++: Custom User
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/users/custom-user-data/)
- [.NET: Custom User
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/manage-users/custom-user-data/)
- [Flutter: Custom User
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/users/custom-user-data/)
- [Java: Custom User
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/users/custom-user-data/)
- [Kotlin: Manage Custom User
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/users/custom-user-data/)
- [Node.js: Access Custom User
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/users/access-custom-user-data/)
- [Swift: Custom User
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/users/custom-user-data/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] 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
- [x] Check related pages for relevant content to include
- [x] Create a ticket for missing examples in each relevant SDK:
Consolidation Gaps epic

### Reviewer Checklist

As a reviewer, please check these items:

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

---------

Co-authored-by: Kyle Rollins <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

-
[Delete](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39516/sdk/crud/delete/)

Note for reviewer: there are some API description tab sets where one or
more tabs is missing a description. That's intentional. In some cases,
there is no relevant info to provide because we're missing an example,
and in other cases, it's because I needed to provide additional info for
_one_ of the languages but didn't have anything relevant to say for the
other languages.

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++:
Delete](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/crud/delete/)
- [Flutter:
Delete](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/crud/delete/)
- [Flutter: Data
Types](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/data-types/#realmvalue)
- [Java:
Delete](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/crud/delete/)
- [Kotlin:
Delete](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/crud/delete/)
- [.NET:
Delete](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/crud/delete/)
- [.NET:
Lists](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/lists/)
- [.NET:
Dictionaries](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/dictionaries/)
- [.NET:
Sets](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/sets/)
- [.NET:
RealmValue](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/realm-value/)
- [Node.js:
Delete](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/crud/delete/)
- [Node.js:
Sets](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/sets/)
- [Node.js:
Dictionaries](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/dictionaries/)
- [Swift:
Delete](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/crud/delete/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] 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
- [x] Check related pages for relevant content to include
- [x] Create a ticket for missing examples in each relevant SDK:
Consolidation Gaps epic

### Reviewer Checklist

As a reviewer, please check these items:

- [x] 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
- [x] All relevant content from individual SDK pages is present on the
consolidated page

---------

Co-authored-by: Kyle Rollins <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

This is a port of the existing Swift page - we decided to maintain these
SDK-specific query engines as one-off pages because they are too
dissimilar to consolidate. I have updated the Realm naming and refs to
use the `sdk` ref targets.

I switched from the Realm languages tab group to the Drivers tab group,
so if someone has selected "Swift" or "Objective-C" from another page, I
believe the selection should carry over. There are some examples that
don't exist or apply in the other language, so if you have selected
"Swift" you will still see some Objective-C examples in the NSPredicate
part of the page, and if you have selected Objective-C, you will still
see the entire Swift Type-Safe Query API and some Swift examples in the
NSPredicate part of the page. I don't plan to go back and address these
or add "missing example" placeholders, because it's the same behavior as
the existing page. But I could be convinced otherwise if a reviewer
feels strongly.

*Staged Page*

- [Type-Safe and NS Predicate
Queries](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39519/sdk/crud/query-engines/filter-data-swift-sdk/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [Swift: Filter
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/crud/filter-data/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)

#### 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

### Reviewer Checklist

As a reviewer, please check these items:

- [x] Realm naming/language has been updated
- [x] All relevant content from individual SDK pages is present on the
consolidated page
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Link User
Identities](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39531/sdk/users/link-user-identities/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [Flutter: Link User
Identities](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/users/link-user-identities/)
- [Java: Link User
Identities](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/users/link-user-identities/)
- [Kotlin: Link User
Identities](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/users/link-credentials/)
- [.NET: Link User
Identities](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/manage-users/link-user-identities/)
- [Node.js: Link User
Identities](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/users/link-identities/)
- [Swift: Link User
Identities](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/users/link-user-identities/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

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

### Reviewer Checklist

As a reviewer, please check these items:

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

---------

Co-authored-by: Kyle Rollins <[email protected]>
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Providers &
Hooks](https://preview-mongodbosharafmdb.gatsbyjs.io/realm/react-providers-and-hooks/frameworks/react/providers-hooks/)

*Page Source*
- [RealmProvider
(@realm/react)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/react-native/api-reference/realm-provider/)
- [AppProvider
(@realm/react)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/react-native/api-reference/app-provider/)
- [UserProvider
(@realm/react)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/react-native/api-reference/user-provider/)

*Note*
This PR is built off a previous PR, [linked
here](#3339). 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [ ] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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](https://jira.mongodb.org/browse/DOCSP-32519) 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
## Pull Request Info - SDK Docs Consolidation

This PR ports the existing SwiftUI content over to the Frameworks
section, updates Realm naming, and removes PBS mentions and examples.

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

### Staging Links

- [Object Models -
SwiftUI](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/model-data/define-an-object-model/)
- [Change an Object Model -
SwiftUI](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/model-data/change-an-object-model/)
- [Configure and Open a Database -
SwiftUI](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/configure-and-open-database/)
- [React to Changes -
SwiftUI](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/react-to-changes/)
- [Pass Data Between SwiftUI
Views](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/pass-data-between-views/)
- [Write Data -
SwiftUI](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/write/)
- [Filter Data -
SwiftUI](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/filter-data/)
- [Handle Sync Errors -
SwiftUI](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/handle-sync-errors/)
- [Sync Data in the Background -
SwiftUI](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/background-sync/)
- [Use the SDK with SwiftUI
Previews](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39546/frameworks/swiftui/swiftui-previews/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [SwiftUI
section](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/swiftui/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [ ] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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](https://jira.mongodb.org/browse/DOCSP-32519) 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
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

-
[Read](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39514/sdk/crud/read/)
- [Read
Properties](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39514/sdk/crud/read/read-properties/)
- [Fluent Interface (Java
SDK)](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39514/sdk/crud/query-engines/filter-data-java-sdk/):
Port content, update Realm naming, and change to use the Drivers tab
languages so it preserves a language selection when clicking into the
page
- [LINQ (.NET
SDK)](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39514/sdk/crud/query-engines/filter-data-linq/):
Port LINQ content, update Realm naming, omit stuff about querying with
RQL as that is generally surfaced in the C# API descriptions on the Read
page

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [C++:
Read](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/crud/read/)
- [Flutter:
Read](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/crud/read/)
- [Flutter: Model
Data/Results](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/data-types/#realmresults)
- [Flutter: Model Data/Geospatial
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/realm-database/model-data/geospatial/)
- [Java:
Read](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/crud/read/)
- [Java: Filter
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/crud/filter-data/)
- [Java: Model
Data/Results](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/data-types/collections/#results-collections)
- [Java: Data Types/Mixed
(Queries)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/model-data/data-types/realmany/#queries)
- [Kotlin:
Read](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/crud/read/)
- [Kotlin: Model Data/Geospatial
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/schemas/geospatials/)
- [.NET:
Read](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/crud/read/)
- [.NET: Filter
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/crud/filter/)
- [.NET: Results
Collections](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/collections/)
- [.NET: Geospatial
Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/model-data/data-types/geospatials/)
- [Node.js:
Read](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/crud/read/)
- [Node.js: Collections (info about
Results)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/collections/)
- [Node.js: Relationships (Inverse relationship
info](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/relationships-and-embedded-objects/)
- [Node.js: Data Types/Dictionaries
(Query)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/dictionaries/#query-for-objects-with-a-dictionary-property)
- [Node.js: Data Types/Sets (info relevant to reading set
properties)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/sets/)
- [Node.js: Data Types/Mixed
(Query)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/mixed/#query-for-objects-with-a-mixed-value)
- [Node.js: Data Types/Geospatial
(Query)](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/model-data/data-types/geospatial/#query-geospatial-data)
- [Swift:
Read](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/crud/read/)
- [Swift: Supported Types: Results & Sectioned
Results](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/model-data/supported-types/#results-and-sectioned-results)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] Shared code boxes have snippets or placeholders for all 9
languages
- [x] API description sections have API details or a generic placeholder
for all 9 languages
- [x] Check related pages for relevant content to include
- [x] 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
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [Add Sync to an
App](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39533/sdk/sync/add-sync-to-app/)

Note for reviewer: some of the API descriptions are intentionally
missing because there isn't necessarily anything else relevant to add.

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [Flutter: Add Sync to an
App](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/sync/add-sync-to-app/)
- [Kotlin: Add Sync to an
App](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/sync/add-sync-to-app/)
- [.NET: Add Sync to an
App](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/sync/add-sync-to-app/)
- [Swift: Add Sync to an
App](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/sync/add-sync-to-app/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] 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
- [x] Check related pages for relevant content to include
- [x] 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
## Pull Request Info - SDK Docs Consolidation

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

*Staged Page*

- [User
Metadata](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39528/sdk/users/user-metadata/)

*Page Source*

Add links to every SDK's pages where you got the SDK-specific
information:

- [Flutter: User
Metadata](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/users/user-metadata/)
- [Kotlin: Manage User
Metadata](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/users/user-metadata/)
- [.NET: User
Metadata](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/manage-users/user-metadata/)
- [Node.js: User
Metadata](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/users/user-metadata/)
- [Swift: User
Metadata](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/users/user-metadata/)

### 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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
- [x] Include `.rst` files comply with [the naming
guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)

#### 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
- [x] [Update any Kotlin API
links](https://jira.mongodb.org/browse/DOCSP-32519) to use the new
Kotlin SDK roles

#### Content
- [x] Shared code boxes have snippets or placeholders for all 9
languages
- [x] API description sections have API details or a generic placeholder
for all 9 languages
- [x] Check related pages for relevant content to include
- [x] 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants