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.
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
[X] I agree to follow this project's Code of Conduct and Contributing Guidelines
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.
Related Issues
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