docs-realm icon indicating copy to clipboard operation
docs-realm copied to clipboard

DOCSP-39509 Reduce Database File Size

Open lindseymoore opened this issue 1 year ago • 2 comments

Pull Request Info - SDK Docs Consolidation

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

Staged Page

Page Source

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

Page is generally called "Reduce Realm File Size":

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

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

lindseymoore avatar May 22 '24 19:05 lindseymoore

Readability for Commit Hash: c0a0ac1f08a0782da683baf669e504eef675df0e

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

Readability scores for changed documents:

  • source/sdk/files/reduce-file-size: Grade Level: 8.9, Reading Ease: 56.76
  • source/sdk/crud/threading: Grade Level: 6.8, Reading Ease: 67.86

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.

github-actions[bot] avatar May 22 '24 19:05 github-actions[bot]

Deploy Preview for device-sdk failed. Why did it fail? →

Name Link
Latest commit bb1969ab2f963b17653098f9dcfae2832d1e38d0
Latest deploy log https://app.netlify.com/sites/device-sdk/deploys/669ad875942ac000086c9b5b

netlify[bot] avatar Jul 19 '24 20:07 netlify[bot]