I suggest addingditional documentation in the DocC-based documentation to provide content for beginners and more experienced developers who want to use Spezi in their apps or want to build their own modules.
Solution
It would be good to add additional documentation in the DocC-based documentation bundle that focuses on the following topics:
[ ] The Spezi Ecosystem: A summary of the prime modules that we offer in Spezi with links to their documentation and use cases.
[ ] Integrating a module in a Spezi-based app: A step-by-step article that can be linked in other Swift packages on how to include a Spezi module in an iOS App (or other Swift Package) using the Swift Package manager, adding the component to the configuration, and potentially using views or an ObservableObject in the SwiftUI environment.
[ ] An article on building your own model, including the lifecycle of a module (init, configure), reusing functionality using @Dependency, and maybe some more advanced elements
[ ] An article on advanced components featured and how to use them, e.g., @Collect and Knowledge sources.
Code of Conduct
[X] I agree to follow this project's Code of Conduct and Contributing Guidelines
Problem
I suggest addingditional documentation in the DocC-based documentation to provide content for beginners and more experienced developers who want to use Spezi in their apps or want to build their own modules.
Solution
It would be good to add additional documentation in the DocC-based documentation bundle that focuses on the following topics:
ObservableObjectin the SwiftUI environment.@Dependency, and maybe some more advanced elements@Collectand Knowledge sources.Code of Conduct