StanfordSpezi / Spezi

Open-source framework for rapid development of modern, interoperable digital health applications.
https://swiftpackageindex.com/StanfordSpezi/Spezi/documentation
MIT License
130 stars 10 forks source link

Optimize DocC bundle structure and update old code examples #83

Closed Supereg closed 10 months ago

Supereg commented 10 months ago

Optimize DocC bundle structure and update old code examples

:recycle: Current situation & Problem

Currently, the documentation exposes still old code examples using the Standard as a generic argument for a Component. Secondly, the DocC bundle is currently rather unstructured, were certain sections are recursively nested into each other.

:gear: Release Notes

:books: Documentation

All done in documentation. It is heavily advised to build the documentation yourself for the PR review process to better understand the changes.

:white_check_mark: Testing

Not applicable

: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 10 months ago

Codecov Report

Merging #83 (99ddfcb) into main (7462510) will not change coverage. The diff coverage is n/a.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83/graphs/tree.svg?width=650&height=150&src=pr&token=KHU2K1HTAM&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi)](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #83 +/- ## ======================================= Coverage 97.63% 97.63% ======================================= Files 34 34 Lines 631 631 ======================================= Hits 616 616 Misses 15 15 ``` | [Files Changed](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [...s/ObservableObject/ObservableObjectComponent.swift](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aS9DYXBhYmlsaXRpZXMvT2JzZXJ2YWJsZU9iamVjdC9PYnNlcnZhYmxlT2JqZWN0Q29tcG9uZW50LnN3aWZ0) | `86.37% <ø> (ø)` | | | [Sources/Spezi/Configuration/Configuration.swift](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aS9Db25maWd1cmF0aW9uL0NvbmZpZ3VyYXRpb24uc3dpZnQ=) | `100.00% <ø> (ø)` | | | [...ilities/Communication/CollectPropertyWrapper.swift](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aS9Nb2R1bGUvQ2FwYWJpbGl0aWVzL0NvbW11bmljYXRpb24vQ29sbGVjdFByb3BlcnR5V3JhcHBlci5zd2lmdA==) | `100.00% <ø> (ø)` | | | [...ilities/Communication/ProvidePropertyWrapper.swift](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aS9Nb2R1bGUvQ2FwYWJpbGl0aWVzL0NvbW11bmljYXRpb24vUHJvdmlkZVByb3BlcnR5V3JhcHBlci5zd2lmdA==) | `100.00% <ø> (ø)` | | | [...rces/Spezi/SharedRepository/SharedRepository.swift](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aS9TaGFyZWRSZXBvc2l0b3J5L1NoYXJlZFJlcG9zaXRvcnkuc3dpZnQ=) | `100.00% <ø> (ø)` | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83?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/Spezi/pull/83?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [7462510...99ddfcb](https://app.codecov.io/gh/StanfordSpezi/Spezi/pull/83?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).