Update Documentation in Conformance to the Documentation Guide

[PSchmiedmayer]

Problem

The current documentations in Spezi modules provides an overview of the API and includes documentation for most public APIs. In line with the newly published Stanford Spezi Documentation Guide, we should update the documentation in accordance with the guidelines.

Solution

The documentations should be updated to provide more insightful inline documentation, improve the README file and the DocC landing page in conformance with the Stanford Spezi Documentation Guide.

• Update inline documentation, including links and other elements noted in the Code Documentation section.
• Improve the DocC landing page as detailed in the Landing Page section.
• Add a graphic and visual representation of the Spezi setup and architecture.
• Improve the READMe as noted in the README section.

Related Issues

• Update Documentation in Conformance to the Documentation Guide Spezi#84
• Update Documentation in Conformance to the Documentation Guide SpeziAccount#13
• Update Documentation in Conformance to the Documentation Guide SpeziOnboarding#16
• Update Documentation in Conformance to the Documentation Guide SpeziMockWebService#7
• Update Documentation in Conformance to the Documentation Guide SpeziLLM#24
• Update Documentation in Conformance to the Documentation Guide SpeziViews#11
• Update Documentation in Conformance to the Documentation Guide SpeziHealthKit#11
• Update Documentation in Conformance to the Documentation Guide SpeziQuestionnaire#10
• Update Documentation in Conformance to the Documentation Guide SpeziFirebase#11
• Update Documentation in Conformance to the Documentation Guide SpeziFHIR#8
• Update Documentation in Conformance to the Documentation Guide SpeziContact#11
• Update Documentation in Conformance to the Documentation Guide SpeziScheduler#26
• Update Documentation in Conformance to the Documentation Guide SpeziStorage#11
• Update Documentation in Conformance to the Documentation Guide SpeziAccessGuard#4

Additional context

Feel free to use comments under the associated issues to discuss the best way to approach update documentation in conformance to the documentation guide for the Spezi modules.

Code of Conduct

• I agree to follow this project's Code of Conduct and Contributing Guidelines