Documentation & Setup Improvements

[PSchmiedmayer]

Documentation & Setup Improvements

:gear: Release Notes

• Adds a DocC-based Documentation to host articles and inline-documentation about different parts of the template application.
• Adds a setup script to automatically install all the necessary tools and software elements to use the Spezi Template Application.
• Adds DocC articles to address part of #55:
  • Setup your development environment
  • Change the template application to fit your project needs
  • Modify the application and point to relevant Spezi Modules

: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

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

Comparison is base (82bda2a) 80.54% compared to head (e9eb7a7) 80.65%.

:exclamation: Current head e9eb7a7 differs from pull request most recent head e0842c8. Consider uploading reports for the commit e0842c8 to get more accurate results

Additional details and impacted files

[](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #59 +/- ## ========================================== + Coverage 80.54% 80.65% +0.12% ========================================== Files 31 33 +2 Lines 976 961 -15 ========================================== - Hits 786 775 -11 + Misses 190 186 -4 ``` | [Files](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [TemplateApplication/Account/AccountButton.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9BY2NvdW50L0FjY291bnRCdXR0b24uc3dpZnQ=) | `100.00% <ø> (ø)` | | | [...mplateApplication/Account/AccountSetupHeader.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9BY2NvdW50L0FjY291bnRTZXR1cEhlYWRlci5zd2lmdA==) | `100.00% <ø> (ø)` | | | [TemplateApplication/Account/AccountSheet.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9BY2NvdW50L0FjY291bnRTaGVldC5zd2lmdA==) | `95.66% <ø> (ø)` | | | [TemplateApplication/Contacts/Contacts.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9Db250YWN0cy9Db250YWN0cy5zd2lmdA==) | `91.84% <ø> (ø)` | | | [...eApplication/Contributions/ContributionsList.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9Db250cmlidXRpb25zL0NvbnRyaWJ1dGlvbnNMaXN0LnN3aWZ0) | `100.00% <ø> (ø)` | | | [...pplication/Contributions/Package+LicenseType.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9Db250cmlidXRpb25zL1BhY2thZ2UrTGljZW5zZVR5cGUuc3dpZnQ=) | `83.73% <ø> (ø)` | | | [...emplateApplication/Contributions/PackageCell.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9Db250cmlidXRpb25zL1BhY2thZ2VDZWxsLnN3aWZ0) | `86.49% <ø> (ø)` | | | [...plateApplication/Contributions/PackageHelper.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9Db250cmlidXRpb25zL1BhY2thZ2VIZWxwZXIuc3dpZnQ=) | `63.64% <ø> (ø)` | | | [TemplateApplication/Helper/Binding+Negate.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9IZWxwZXIvQmluZGluZytOZWdhdGUuc3dpZnQ=) | `100.00% <ø> (ø)` | | | [TemplateApplication/Helper/Bundle+Image.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-VGVtcGxhdGVBcHBsaWNhdGlvbi9IZWxwZXIvQnVuZGxlK0ltYWdlLnN3aWZ0) | `0.00% <ø> (ø)` | | | ... and [23 more](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?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/SpeziTemplateApplication/pull/59?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/SpeziTemplateApplication/pull/59?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [82bda2a...e0842c8](https://app.codecov.io/gh/StanfordSpezi/SpeziTemplateApplication/pull/59?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).