-
Notifications
You must be signed in to change notification settings - Fork 89
(DOCSP-39501): Consolidate Quick Start page #3280
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-39501): Consolidate Quick Start page #3280
Conversation
Readability for Commit Hash: 5d39838 You can see any previous Readability scores (if they exist) by looking Readability scores for changed documents:
For Grade Level, aim for 8 or below. For Reading Ease scores, aim for 60 or above:
For help improving readability, try Hemingway App. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hopefully my feedback isn't too difficult to sift through (I had lots of stops and starts, so apologies if my comments are inconsistent). Overall, only a few actual typos/blocking issues. The rest are suggestions or notes for future work 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this could definitely be replaced with the generic I mentioned earlier
At the top of your source files where you want to use the SDK, add | ||
the appropriate imports. For this quick start, we use these imports: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can be replaced with the generic import includes I mentioned earlier
.../includes/api-details/swift/quick-start/quick-start-define-your-object-model-description.rst
Outdated
Show resolved
Hide resolved
Near the top of any Swift file that uses the SDK, add the following import | ||
statement: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can use the generic includes i mentioned earlier
source/includes/api-details/swift/quick-start/quick-start-import-realm-description.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>
Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>
Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>
…rt-realm-description.rst Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>
8ee6c6b
into
mongodb:feature-consolidated-sdk-docs
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/feature-consolidated-sdk-docs/ 🪵 Logs |
Pull Request Info - SDK Docs Consolidation
Jira ticket: https://jira.mongodb.org/browse/DOCSP-39501
Staged Page
Adding a note here to capture this in the PR record:
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:
feature-consolidated-sdk-docs
branch instead ofmaster
Naming
.rst
files comply with the naming guidelinesLinks and Refs
Content
Reviewer Checklist
As a reviewer, please check these items: