Updated Spezi documentation #68
Conversation
There was a problem hiding this comment.
Thank you @AdritRao for starting to work on this. Goes in the right direction and will be very helpful for people to get started 🚀
TemplateApplication/Supporting Files/TemplateApplication.docc/TemplateApplication.md
Show resolved
Hide resolved
|
@AdritRao Wanted to follow-up on this PR; should we continue to push for this here or would it make sense to close the PR? |
|
Hi @PSchmiedmayer, I have addressed the comments in the latest commit. Thank you! |
PSchmiedmayer
added
enhancement
There was a problem hiding this comment.
Thank you for working on this @AdritRao!
I had some smaller comments; we might need to double-check that everything is linked correctly in the documentation if we build it on Xcode + work on some of the comments.
TemplateApplication/Supporting Files/TemplateApplication.docc/TemplateApplication.md
Outdated
Show resolved
Hide resolved
TemplateApplication/Supporting Files/TemplateApplication.docc/TemplateApplication.md
Outdated
Show resolved
Hide resolved
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #68 +/- ##
=======================================
Coverage 86.73% 86.73%
=======================================
Files 21 21
Lines 693 693
=======================================
Hits 601 601
Misses 92 92
Continue to review full report in Codecov by Sentry.
|
Co-authored-by: Paul Schmiedmayer <PSchmiedmayer@users.noreply.github.com>
|
Thank you for the feedback @PSchmiedmayer! I have addressed them and tested the documentation by building it on Xcode. |
There was a problem hiding this comment.
Thank you for all the improvements; I had a few small feedback elements that I noticed when rendering the documentation in Xcode; happy to see this merged once the last round of feedback is incorporated.
Thank you @AdritRao for working on this! 🚀
There was a problem hiding this comment.
Thank you for all the improvements here, looks nice!
It would be amazing if every view linked here has a proper documentation description similar to the ones in the other views. We should ensure that clicking on a link would show some more hints and suggestions.
| /// | ||
| /// Customize the HealthKitPermissions view to specify your app's usage of HealthKit data to the user. | ||
| /// | ||
| /// You can learn more about [Spezi Onboarding in the GitHub repository](https://github.com/StanfordSpezi/SpeziOnboarding) |
There was a problem hiding this comment.
Might be a copy and past error here; we should double check this for all files as well 👍
| /// You can learn more about [Spezi Onboarding in the GitHub repository](https://github.com/StanfordSpezi/SpeziOnboarding) | |
| /// You can learn more about [Spezi HealthKit in the GitHub repository](https://github.com/StanfordSpezi/Spezi HealthKit) |
| ///  | ||
| ///  |
There was a problem hiding this comment.
The screenshots are currently shown in a really large size; it might not be the desirable size. I would suggest that we use a trick of having a @Row with a size of e.g., 3 columns that only contains one or two and therefore scales the images accordingly.
| ///  | |
| ///  | |
| /// @Row(numberOfColumns: 3) { | |
| /// @Column(size: 1) { | |
| /// @Image(source: "HealthKitAccess", alt: "HealthKit Onboarding Flow") | |
| /// } | |
| /// @Column(size: 1) { | |
| /// @Image(source: "HealthKitSheet", alt: "Permissions screen of the HealthKit framework") | |
| /// } | |
| /// } |
Applies to other parts of the documentation as well.
Updated Spezi documentation
♻️ Current situation & Problem
Currently, the individual module pages are auto-generated in the Spezi documentation. These pages do not contain iPhone screenshots nor a brief description of the module's purpose.
⚙️ Release Notes
📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: