Issue - 275 (Meaningful Documentation)

[Ivan2001otp]

Description

This PR involves creating meaningful documentation for the codebase of Flutter app -Resonate .It provides convenient way to understand the code . Tried to explain the key functionalities , wherever it is necessary.

Fixes # (issue) Issues-275.

Type of change

Documentation update.

• [x] Documentation update

Please include screenshots below if applicable. No screenshots in documentation update.

Checklist:

• [x] My code follows the style guidelines of this project
• [ ] I have performed a self-review of my own code
• [ ] I have commented my code, particularly in hard-to-understand areas
• [x] I have made corresponding changes to the documentation
• [ ] My changes generate no new warnings
• [ ] I have added tests that prove my fix is effective or that my feature works
• [ ] New and existing unit tests pass locally with my changes
• [ ] Any dependent changes have been merged and published in downstream modules
• [ ] I have checked my code and corrected any misspellings

Maintainer Checklist

• [x] closes #275 (Replace xxxx with the GitHub issue number)
• [x] Documentation Update

[Ivan2001otp]

Please provide me the feedback , whether the documentation provided meets the expectation , if not feel free to provide me constructive suggestion.Thank you.

[Aarush-Acharya]

Hey @Ivan2001otp thank you for your contribution, Great Work 🚀✨

Please do implement the suggested changes and push again, along with solving the merge conflicts with the current state of the repository.

We await your reply as a token of acknowledgement, will merge once the requested changes are done

P.S. Make this done ASAP as these are just documentation related changes should not take much time, also resolve the conflicts carefully, I will try to get this merged by tomorrow

[Aarush-Acharya]

Hey @Ivan2001otp you there please acknowledge, with a response if we do not receive a response from your side in the next 3 days we would have to close this PR

[Aarush-Acharya]

Hey @Ivan2001otp we need a reply from your side as a token of acknowledgement, in order to prove your activeness, we will close the PR if we do not hear from you within the next 3 - 4 days

[SarthakPaandey]

@Aarush-Acharya may i work on this if @Ivan2001otp is not responding.