DOCSP-35364: Flutter SDK - Nested Collections of Mixed Data

[cbullinger]

Pull Request Info

NOTE: This PR is temporarily using an alpha snapshot - unit tests will fail. Upgrading to v2.0.0 release, once it's available, may impact some of the code examples.

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

• Define an Object Schema: Added new "Modeled Unstructured Data" section with example
• Data Types: Updated RealmValue mixed data type section with new info and examples for collections in mixed; added note re. breaking change (links to migration page from a separate PR)
• Read: Add new Query Nested Collections of Mixed Data (needs query examples added as part of RQL ticket)

Reminder Checklist

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

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

Release Notes

• Flutter SDK
  • Realm Database/Model Data/Define an Object Schema: New "Modeled Unstructured Data" section added with a tested, Bluehawked code example to document nested collections of mixed data.
  • Realm Database/Model Data/Data Types: RealmValue section updated to document the new support for nested collections of mixed data and additional changes to the data type. Tested, Bluehawked code examples were updated or added.
  • Realm Database/CRUD/Read: New "Query Nested Collections of Mixed Data" section added with a tested, Bluehawked code example to document new RQL queries for nested collections.

Review Guidelines

REVIEWING.md

[github-actions]

Readability for Commit Hash: a97a303

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

Readability scores for changed documents:

• source/sdk/flutter/realm-database/model-data/data-types: Grade Level: 7.9, Reading Ease: 59.5
• source/sdk/flutter/realm-database/model-data/define-realm-object-schema: Grade Level: 8.6, Reading Ease: 57.77
• source/sdk/flutter/crud/read: Grade Level: 8.3, Reading Ease: 58.38

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.

[nirinchev]

I haven't gone through the whole thing yet since it's quite late, but I'll get to it on Monday! I think the structure is sound, but we could come up with better examples. There are a few inaccuracies as well that I've highlighted.

[lindseymoore]

Overall, content looks good! A few smaller suggestions and fixes.
For code snippets, I would like to see introduction comments to explain what the code is doing. Sometimes you explain what the code is doing in the text, sometimes not. I think an introduction comment is helpful whether the code is explained in text or not, given the code is copyable.

[lindseymoore]

Suggested change

	in the nested data and to update specific elements, but it is less
	performant than using a structured schema or serializing JSON blobs
	in the nested data and to update specific elements. However in some cases, it is less
	performant than using a structured schema or serializing JSON blobs.

Why it is less performant? Maybe give some reasons or cases where it would be less performant.

[cbullinger]

I've noted this for a fast follow addition. I'll need to get more info from engineering for the additional details

[lindseymoore]

Some typos and more stuff about comments, add at your discretion. Otherwise, LGTM!

[docs-builder-bot]

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/

🪵 Logs

• job log: 4fe38a1d56dc187874ca4746fc787c7f4a35d907