Update Documentation in Conformance to the Documentation Guide

[vishnuravi]

Update Documentation in Conformance to the Documentation Guide

♻️ Current situation & Problem

See issue #16.

📝 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.

[codecov]

Codecov Report

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

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #25   +/-   ##
=======================================
  Coverage   72.65%   72.65%           
=======================================
  Files          14       14           
  Lines         797      797           
=======================================
  Hits          579      579           
  Misses        218      218           

Files	Coverage Δ
Sources/SpeziOnboarding/ConsentView.swift	88.47% <ø> (ø)
...eziOnboarding/OnboardingFlow/OnboardingStack.swift	83.34% <ø> (ø)
...oarding/OnboardingFlow/OnboardingViewBuilder.swift	53.85% <ø> (ø)

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e0b11e1...16352af. Read the comment docs.

[PSchmiedmayer]

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 👍

[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!