Update Documentation in Conformance to the Documentation Guide

[vishnuravi]

Update Documentation in Conformance to the Documentation Guide

:recycle: Current situation & Problem

See Issue #11.

: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

Merging #22 (51c3db8) into main (db46d60) will not change coverage. The diff coverage is n/a.

Additional details and impacted files

[](https://app.codecov.io/gh/StanfordSpezi/SpeziFirebase/pull/22?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #22 +/- ## ======================================= Coverage 59.91% 59.91% ======================================= Files 19 19 Lines 1065 1065 ======================================= Hits 638 638 Misses 427 427 ``` ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziFirebase/pull/22?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/SpeziFirebase/pull/22?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [db46d60...51c3db8](https://app.codecov.io/gh/StanfordSpezi/SpeziFirebase/pull/22?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).

[PSchmiedmayer]

@vishnuravi Thank you for improving the documentation here! @Supereg would be the best to review and provide feedback until I am back in the office after Thanksgiving break; feel free to coordinate the feedback, ideas what to present in the README, and PR review with him 🎉

[Supereg]

Current state was incorporated within #26. Will close for now, assuming there is no additional local work which is not yet pushed to the PR.

[PSchmiedmayer]

@vishnuravi Feel free to remove the branch if the content there is no longer needed 👍