Update Documentation in Conformance to the Documentation Guide

[vishnuravi]

Update Documentation in Conformance to the Documentation Guide

:recycle: Current situation & Problem

See issue #16.

:pencil: Code of Conduct & Contributing Guidelines

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

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

[codecov[bot]]

Codecov Report

Merging #25 (16352af) into main (e0b11e1) will not change coverage. The diff coverage is n/a.

Additional details and impacted files

[](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #25 +/- ## ======================================= Coverage 72.65% 72.65% ======================================= Files 14 14 Lines 797 797 ======================================= Hits 579 579 Misses 218 218 ``` | [Files](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [Sources/SpeziOnboarding/ConsentView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvQ29uc2VudFZpZXcuc3dpZnQ=) | `88.47% <ø> (ø)` | | | [...eziOnboarding/OnboardingFlow/OnboardingStack.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvT25ib2FyZGluZ1N0YWNrLnN3aWZ0) | `83.34% <ø> (ø)` | | | [...oarding/OnboardingFlow/OnboardingViewBuilder.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/25?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvT25ib2FyZGluZ1ZpZXdCdWlsZGVyLnN3aWZ0) | `53.85% <ø> (ø)` | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/25?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/25?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [e0b11e1...16352af](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/25?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi).

[vishnuravi]

Thank you for the documentation improvements @vishnuravi! The screenshots and the examples look great 🚀

I took a look at the PR and updated a few things in the following commit: fceaae8. Fixes some warnings when the documentation is created including missing links as well as the issue that the dark mode ~dark prefix is needed to ensure the the views are automatically displayed in the dark mode.

If you are happy with the PR state, feel free to merge the PR 👍

Great, thank you @PSchmiedmayer!