search

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

Refactor documentation to make it more concise #33

Closed Supereg closed 5 months ago

Supereg commented 5 months ago

Refactor documentation to make it more concise

:recycle: Current situation & Problem

This PR refine the documentation to be more concise by providing a short and concise summary for all types. Further, we update the package to the latest Spezi 1.0 releases.

:gear: Release Notes

:pencil: Code of Conduct & Contributing Guidelines

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

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (f396284) 71.28% compared to head (a130371) 74.63%.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33/graphs/tree.svg?width=650&height=150&src=pr&token=tVwIFVPdJG&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi)](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #33 +/- ## ========================================== + Coverage 71.28% 74.63% +3.35% ========================================== Files 21 21 Lines 1055 1001 -54 ========================================== - Hits 752 747 -5 + Misses 303 254 -49 ``` | [Files](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [...sentView/ConsentDocument+ExportConfiguration.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvQ29uc2VudFZpZXcvQ29uc2VudERvY3VtZW50K0V4cG9ydENvbmZpZ3VyYXRpb24uc3dpZnQ=) | `84.22% <ø> (ø)` | | | [.../SpeziOnboarding/ConsentView/ConsentDocument.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvQ29uc2VudFZpZXcvQ29uc2VudERvY3VtZW50LnN3aWZ0) | `87.71% <ø> (ø)` | | | [...ources/SpeziOnboarding/OnboardingActionsView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0FjdGlvbnNWaWV3LnN3aWZ0) | `58.14% <ø> (+16.48%)` | :arrow_up: | | [...ources/SpeziOnboarding/OnboardingConsentView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0NvbnNlbnRWaWV3LnN3aWZ0) | `76.70% <ø> (ø)` | | | [...ing/OnboardingFlow/IllegalOnboardingStepView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvSWxsZWdhbE9uYm9hcmRpbmdTdGVwVmlldy5zd2lmdA==) | `0.00% <ø> (ø)` | | | [...arding/OnboardingFlow/NavigationPath+Codable.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvTmF2aWdhdGlvblBhdGgrQ29kYWJsZS5zd2lmdA==) | `94.74% <ø> (ø)` | | | [...ding/OnboardingFlow/OnboardingNavigationPath.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvT25ib2FyZGluZ05hdmlnYXRpb25QYXRoLnN3aWZ0) | `83.97% <100.00%> (-0.72%)` | :arrow_down: | | [...eziOnboarding/OnboardingFlow/OnboardingStack.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvT25ib2FyZGluZ1N0YWNrLnN3aWZ0) | `100.00% <ø> (+16.67%)` | :arrow_up: | | [...ding/OnboardingFlow/OnboardingStepIdentifier.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvT25ib2FyZGluZ1N0ZXBJZGVudGlmaWVyLnN3aWZ0) | `100.00% <ø> (ø)` | | | [...oarding/OnboardingFlow/OnboardingViewBuilder.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvT25ib2FyZGluZ1ZpZXdCdWlsZGVyLnN3aWZ0) | `53.85% <ø> (ø)` | | | ... and [6 more](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?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/33?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [f396284...a130371](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/33?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).