-
Notifications
You must be signed in to change notification settings - Fork 88
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-39147): Update SPM install instructions and privacy manifest details #3237
Conversation
Readability for Commit Hash: 65ba6b0 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.
LGTM! A few minor suggestions for clarity.
source/sdk/swift/install.txt
Outdated
To use the Privacy Manifest supplied by the SDK, build ``RealmSwift`` | ||
as a dynamic framework. If you build ``RealmSwift`` as a static | ||
framework, you must supply your own Privacy Manifest. To build | ||
``RealmSwift`` as a dynamic framework: |
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.
Minor suggestion: Maybe move "To build RealmSwift
as a dynamic framework:" to a new line so that it offsets the procedural stuff a bit. Makes it easier to scan the page and pick up what the procedure is about.
source/sdk/swift/test-and-debug.txt
Outdated
@@ -272,3 +280,35 @@ Bad Alloc/Not Enough Memory Available | |||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
|
|||
.. include:: /includes/ios-ipados-bad-alloc.rst | |||
|
|||
.. _swift-package-target-10-40-3-change: |
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.
Is the 10-40-3
supposed to reference the SDK version? If so, wouldn't it be 10-49-3
? I may be misunderstanding the purpose of this ref.
source/sdk/swift/test-and-debug.txt
Outdated
1. In your project :guilabel:`Targets`, select your build target. | ||
2. Go to the :guilabel:`Build Phases` tab. | ||
3. Expand the :guilabel:`Link Binary With Libraries` element. | ||
4. Select either ``Realm`` or ``RealmSwift``, and click the :guilabel:`-` to |
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.
Is this an icon button in Xcode? Does it have alt text? This looks like a typo when rendered to the page.
If there's alt text, can we do something like "click the button (:guilabel:`-`)"?
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.
Hah, Cory usually tells me to remove "button" when I use it (old habit from old MMOS). I have never seen the alt text display, but I'm sure there must be some - let me see what I can figure out.
source/sdk/swift/test-and-debug.txt
Outdated
2. Go to the :guilabel:`Build Phases` tab. | ||
3. Expand the :guilabel:`Link Binary With Libraries` element. | ||
4. Select either ``Realm`` or ``RealmSwift``, and click the :guilabel:`-` to | ||
remove the unneeded binary. For details about which binary to link with, |
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.
The "with" here confused me a bit. Can we go with "link" by itself?
remove the unneeded binary. For details about which binary to link with, | |
remove the unneeded binary. For details about which binary to link, |
✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/ 🪵 Logs |
Pull Request Info
Jira ticket: https://jira.mongodb.org/browse/DOCSP-39147
Realm
andRealmSwift
.Reminder Checklist
Before merging your PR, make sure to check a few things.
Release Notes
Realm
andRealmSwift
.Review Guidelines
REVIEWING.md