mongodb / docs-realm

Realm Database SDK documentation
https://www.mongodb.com/docs/realm/
44 stars 88 forks source link

(DOCSP-39500): Consolidate Install page #3326

Closed dacharyc closed 2 months ago

dacharyc commented 2 months ago

Pull Request Info - SDK Docs Consolidation

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

Notes for Reviewer Only five of the pages listed here should be considered to be in a "complete" state as of this PR:

I moved content off of existing install pages onto a bunch of other pages, but those pages will get more updates in the future to make them coherent pages. For now, you only need to confirm that the content got moved successfully and everything is still working.

Also, noting here that per conversations with the product and engineering teams, we are intentionally omitting the Java SDK (Java and Java-Kotlin) from the Install page.

Staged Page

Page Source

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

PR Author Checklist

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

Naming

Links and Refs

Content

Reviewer Checklist

As a reviewer, please check these items:

github-actions[bot] commented 2 months ago

Readability for Commit Hash: 889f3157da42fed74fcb9cf8d5cdf39c40716318

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

Readability scores for changed documents:

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.

netlify[bot] commented 2 months ago

Deploy Preview for device-sdk ready!

Name Link
Latest commit 889f3157da42fed74fcb9cf8d5cdf39c40716318
Latest deploy log https://app.netlify.com/sites/device-sdk/deploys/66aa374ff816e70008f52455
Deploy Preview https://deploy-preview-3326--device-sdk.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

Lighthouse
1 paths audited
Performance: 32 (πŸ”΄ down 3 from production)
Accessibility: 92 (πŸ”΄ down 1 from production)
Best Practices: 75 (no change from production)
SEO: 62 (πŸ”΄ down 7 from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.