Updated Spezi documentation #68
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
PSchmiedmayer
requested changes
May 17, 2024
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 🚀
| /// | ||
| /// Modify the contact details for your app in the Contacts view. | ||
| /// | ||
| ///  | ||
|
|
There was a problem hiding this comment.
To render the documentation it would require to remove the empty line between the docs & the type. Also applies to other files.
| @@ -10,8 +10,12 @@ import Foundation | |||
| import SpeziContact | |||
| import SwiftUI | |||
|
|
|||
There was a problem hiding this comment.
Please ensure that you have two empty lines between the import statements and the first lines of the swift files. Also applies to other files.
| @@ -10,8 +10,12 @@ import Foundation | |||
| import SpeziContact | |||
| import SwiftUI | |||
|
|
|||
| /// Display contacts for your app. | |||
| /// | |||
| /// Modify the contact details for your app in the Contacts view. | |||
There was a problem hiding this comment.
Very nice! It might even make sense to link to the relevant module documentations here. Also applies to other files.
There was a problem hiding this comment.
Very nice additions @AdritRao!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: