Skip to content

Conversation

cbullinger
Copy link
Collaborator

@cbullinger cbullinger commented May 21, 2024

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

Page Source

PR Author Checklist

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

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

Naming

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
  • N/A [ ] Update any Kotlin API links to use the new Kotlin SDK roles

Content

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

Copy link

github-actions bot commented May 30, 2024

Readability for Commit Hash: b28e7ac

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/query-engines/realm-query-language: Grade Level: 9.8, Reading Ease: 49.21

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.

@cbullinger cbullinger force-pushed the docsp-36298-rql branch 2 times, most recently from b905b74 to ccd9cd4 Compare May 31, 2024 14:59
@cbullinger cbullinger marked this pull request as ready for review May 31, 2024 15:15
@cbullinger cbullinger added the merge to feature branch Unreleased feature - do not merge to Master label Jun 3, 2024
Copy link
Collaborator

@dacharyc dacharyc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, great job! This is a massive unit of work and I really like the new shape of the page. 🎉

I've got a handful of random comments, but only a couple are actually blocking - we should use the cpp-sdk ID instead of cpp, and there was a nill typo I pointed out. The rest is pretty subjective, so feel free to take it or leave it, or move some of the comments out to a future unit of work.

@cbullinger cbullinger merged commit 9cd2167 into mongodb:feature-consolidated-sdk-docs Jul 19, 2024
@cbullinger cbullinger deleted the docsp-36298-rql branch July 19, 2024 17:24
@docs-builder-bot
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge to feature branch Unreleased feature - do not merge to Master
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants