Skip to content
This repository was archived by the owner on Dec 4, 2025. It is now read-only.

Conversation

@dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented May 7, 2024

Pull Request Info

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

Review Guidelines

REVIEWING.md

@dacharyc dacharyc force-pushed the scaffold-consolidated-sdk-toc branch from 88851a2 to 43d6c79 Compare May 13, 2024 18:49
@github-actions
Copy link

github-actions bot commented May 13, 2024

Readability for Commit Hash: b9bead6

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

Readability scores for changed documents:

  • source/sdk/telemetry: Grade Level: 8.4, Reading Ease: 36.62
  • source/sdk/atlas: Grade Level: 18.6, Reading Ease: -6.02
  • source/sdk/release-notes: Grade Level: 14.8, Reading Ease: -1.49
  • source/sdk/install: Grade Level: 7.4, Reading Ease: 49.99
  • source/sdk/users: Grade Level: 29.9, Reading Ease: -67.95
  • source/sdk/model-data: Grade Level: 24.5, Reading Ease: -42.91
  • source/sdk/sync: Grade Level: 26.2, Reading Ease: -31.23
  • source/sdk/react-to-changes: Grade Level: 10.0, Reading Ease: 32.56
  • source/sdk/serialization: Grade Level: 16.6, Reading Ease: -6.36
  • source/sdk/files: Grade Level: 20.7, Reading Ease: -11.61
  • source/sdk/crud: Grade Level: 14.6, Reading Ease: 31.21
  • source/sdk/test-and-debug: Grade Level: 17.4, Reading Ease: -2.98
  • source/sdk/quick-start: Grade Level: 4.1, Reading Ease: 80.28
  • source/sdk/api-reference: Grade Level: 20.5, Reading Ease: -43.29
  • source/sdk/files/encrypt-file: Grade Level: 6.2, Reading Ease: 58.45
  • source/sdk/files/reduce-file-size: Grade Level: 5.2, Reading Ease: 66.4
  • source/sdk/files/bundle-file: Grade Level: 2.9, Reading Ease: 83.32
  • source/sdk/files/configure-and-open: Grade Level: 7.0, Reading Ease: 56.42
  • source/sdk/files/delete-file: Grade Level: 2.9, Reading Ease: 83.32
  • source/sdk/crud/query-engines: Grade Level: 19.0, Reading Ease: -7.04
  • source/sdk/crud/threading: Grade Level: 8.4, Reading Ease: 36.62
  • source/sdk/crud/update: Grade Level: 11.1, Reading Ease: 34.93
  • source/sdk/crud/read: Grade Level: 8.8, Reading Ease: 51.85
  • source/sdk/crud/delete: Grade Level: 9.6, Reading Ease: 44.41
  • source/sdk/crud/create: Grade Level: 8.9, Reading Ease: 56.96
  • source/sdk/crud/query-engines/filter-data-linq: Grade Level: 4.1, Reading Ease: 74.86
  • source/sdk/crud/query-engines/filter-data-swift-sdk: Grade Level: 4.3, Reading Ease: 74.35
  • source/sdk/crud/query-engines/filter-data-java-sdk: Grade Level: 8.8, Reading Ease: 46.44
  • source/sdk/crud/query-engines/realm-query-language: Grade Level: 8.2, Reading Ease: 58.79
  • source/sdk/users/manage-email-password-users: Grade Level: 11.3, Reading Ease: 23.59
  • source/sdk/users/user-metadata: Grade Level: 12.3, Reading Ease: 21.06
  • source/sdk/users/multi-user-applications: Grade Level: 15.9, Reading Ease: -4.33
  • source/sdk/users/link-user-identities: Grade Level: 11.3, Reading Ease: 23.59
  • source/sdk/users/create-and-delete-users: Grade Level: 1.3, Reading Ease: 92.8
  • source/sdk/users/authenticate-users: Grade Level: 12.3, Reading Ease: 21.06
  • source/sdk/users/manage-user-api-keys: Grade Level: 8.2, Reading Ease: 47.96
  • source/sdk/users/custom-user-data: Grade Level: 10.2, Reading Ease: 32.05
  • source/sdk/test-and-debug/log: Grade Level: 10.7, Reading Ease: 30.53
  • source/sdk/test-and-debug/troubleshoot: Grade Level: 15.1, Reading Ease: 3.12
  • source/sdk/test-and-debug/test: Grade Level: 10.7, Reading Ease: 30.53
  • source/sdk/sync/manage-sync-sessions: Grade Level: 9.0, Reading Ease: 40.51
  • source/sdk/sync/add-sync-to-app: Grade Level: 2.9, Reading Ease: 88.74
  • source/sdk/sync/handle-sync-errors: Grade Level: 6.2, Reading Ease: 58.45
  • source/sdk/sync/write-to-synced-database: Grade Level: 5.2, Reading Ease: 71.82
  • source/sdk/sync/event-library: Grade Level: 6.9, Reading Ease: 67.35
  • source/sdk/sync/partition-based-sync: Grade Level: 12.3, Reading Ease: 21.06
  • source/sdk/sync/stream-data-to-atlas: Grade Level: 10.4, Reading Ease: 31.55
  • source/sdk/sync/manage-sync-subscriptions: Grade Level: 12.7, Reading Ease: 14.63
  • source/sdk/sync/configure-and-open-synced-database: Grade Level: 7.2, Reading Ease: 55.91
  • source/sdk/atlas/connect: Grade Level: 6.0, Reading Ease: 64.37
  • source/sdk/atlas/access-mongodb: Grade Level: 8.0, Reading Ease: 53.88
  • source/sdk/atlas/call-function: Grade Level: 4.3, Reading Ease: 74.35
  • source/sdk/model-data/change-object-model: Grade Level: 8.0, Reading Ease: 48.47
  • source/sdk/model-data/model-data-device-sync: Grade Level: 7.0, Reading Ease: 56.42
  • source/sdk/model-data/object-models: Grade Level: 6.5, Reading Ease: 63.05
  • source/sdk/model-data/relationships: Grade Level: 14.3, Reading Ease: 10.56
  • source/sdk/model-data/supported-types: Grade Level: 10.0, Reading Ease: 37.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.

@dacharyc
Copy link
Collaborator Author

This has served its purpose. Closing in favor of #3255 , which is an upstream feature branch with the final repo structure and clean build log.

@dacharyc dacharyc closed this May 15, 2024
@dacharyc dacharyc deleted the scaffold-consolidated-sdk-toc branch May 15, 2024 17:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant