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

DOCSP-32067: Update Create page for Kotlin #3039

Merged
merged 7 commits into from
Oct 6, 2023

Conversation

cbullinger
Copy link
Collaborator

@cbullinger cbullinger commented Oct 3, 2023

Pull Request Info

  • Convert existing Read & Write Data landing page to a container page and move content to relevant child pages
  • Update existing Create page with missing content and improved code examples using updated object models

Jira

Staged Changes

Reminder Checklist

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

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

Review Guidelines

REVIEWING.md

@github-actions
Copy link

github-actions bot commented Oct 3, 2023

Readability for Commit Hash: b7d0769

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

Readability scores for changed documents:

  • source/sdk/kotlin/realm-database: Grade Level: 11.4, Reading Ease: 39.53
  • source/sdk/kotlin/realm-database/crud: Grade Level: 16.8, Reading Ease: 9.38
  • source/sdk/kotlin/realm-database/schemas/relationships: Grade Level: 11.8, Reading Ease: 44.03
  • source/sdk/kotlin/realm-database/schemas/supported-types: Grade Level: 12.1, Reading Ease: 37.81
  • source/sdk/kotlin/realm-database/schemas/define-realm-object-model: Grade Level: 11.1, Reading Ease: 45.86
  • source/sdk/kotlin/realm-database/crud/create: Grade Level: 10.6, Reading Ease: 46.98

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.

Copy link
Collaborator

@krollins-mdb krollins-mdb left a comment

Choose a reason for hiding this comment

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

@cbullinger, nice work on this page! I love seeing everything in one place. I don't have any comments on the larger structure of the page, but I do have a bunch of minor suggestions throughout. I don't think any of them alone or even all of them together are blockers.

@cbullinger cbullinger force-pushed the docsp-32067-create-page branch from a27dda6 to b7d0769 Compare October 6, 2023 15:29
@cbullinger cbullinger merged commit 977eae5 into mongodb:master Oct 6, 2023
6 checks passed
@cbullinger cbullinger deleted the docsp-32067-create-page branch October 6, 2023 15:42
@docs-builder-bot
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants