StanfordSpezi / SpeziOnboarding

Spezi Onboarding module to inform a user or retrieve consent for a study participation

https://swiftpackageindex.com/StanfordSpezi/SpeziOnboarding/documentation/

MIT License

11 stars 5 forks source link

Update Documentation for OnboardingView screen - signed commit #41

Closed akanshyabhat closed 4 months ago

akanshyabhat commented 4 months ago

Update Documentation for OnboardingView screen - signed commit

:recycle: Current situation & Problem

I noticed that the documentation for the initializers and overall descriptions of this screen were a bit unclear vague when I was trying to use them.

All of these changes were copied over from my previous pull request for signed commits.

:gear: Release Notes

N/A

:books: Documentation

I added documentation to provide a coding example of the initializer of OnboardingView, as well as a more detailed explanation.
Also added an example fo the custom initializer

:white_check_mark: Testing

N/A

:pencil: Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

[ ] I agree to follow the Code of Conduct and Contributing Guidelines.