Closed dacharyc closed 2 months ago
Readability for Commit Hash: a9d25d60eab9aa973d59f17c142ea76c5c66c34e
You can see any previous Readability scores (if they exist) by looking at the comment's history.
Readability scores for changed documents:
For Grade Level, aim for 8 or below.
For Reading Ease scores, aim for 60 or above:
Score | Difficulty |
---|---|
90-100 | Very Easy |
80-89 | Easy |
70-79 | Fairly Easy |
60-69 | Medium |
50-59 | Fairly Hard |
30-49 | Hard |
0-29 | Very Hard |
For help improving readability, try Hemingway App.
LGTM! Only lingering question is that the Kotlin page includes how to make the different types of relationship for embedded objects. Is this specific to Kotlin and will this information be included in the embedded object section for Kotlin? @dacharyc Link to Kotlin page: https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/realm-database/schemas/relationships/#define-an-embedded-object
Totally reasonable question, @lindseymoore ! In the consolidated docs set, the Embedded Object info is on the "Define an Object Model" page - you can see the details in this PR: https://github.com/mongodb/docs-realm/pull/3314
Here's the section about Embedded Objects: https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39502/sdk/model-data/object-models/#define-an-embedded-object
I removed the info from here because embedded objects aren't related objects in the same way as the other relationships here. They can't exist independent of their parent object. The relationships described here are about linking two object types that each have independent lifecycles. The concept info here does mention embedded objects and link out to the other page, but obviously the page content isn't populated here - it's in the PR for the consolidated "Define an Object Model" page.
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/feature-consolidated-sdk-docs/
Pull Request Info - SDK Docs Consolidation
Jira ticket: https://jira.mongodb.org/browse/DOCSP-39503
Staged Page
Page Source
Add links to every SDK's pages where you got the SDK-specific information:
PR Author Checklist
Before requesting a review for your PR, please check these items:
feature-consolidated-sdk-docs
branch instead ofmaster
Naming
.rst
files comply with the naming guidelinesLinks and Refs
Content
Reviewer Checklist
As a reviewer, please check these items: