Improve documentation

[shatanikmahanty]

Improve documentation of this project by following Effective Dart Principles.

We use dart doc to generate documentation.

Use 'dart doc .' from project root to generate documentation website

This repo will always be up for grabs. These are the following things you can do to contribute to this repo:

• Add a .md file for a category in dartdoc_options.yaml.
• Improve documentation for project-level code
• Add new documentation

Things to keep in mind while contributing:

• Make sure to comment on this issue about what you intend to do. (Eg: I want to change documentation for certain pages, I want to add new pages, I added a new .md file, etc.). Make sure you mention exactly which pages you want to change.
• Make sure to check if anyone else is already working on documenting a page before asking for contributing to that.
• Make sure not to change more than 2 files per pull request. (We do this so that everyone gets a chance to contribute).
• Lastly, start contributing when you are assigned to the issue.

Happy documenting 😀

[Adelakin-Adewumi]

Hi, in case you are ready to add the description. i'd love to help with the documentation

[shatanikmahanty]

Hi, in case you are ready to add the description. i'd love to help with the documentation

Definitely, we are finalizing some minor things about documentation. We will be finalizing by 2nd October. Happy contributing

[Adelakin-Adewumi]

Hi, in case you are ready to add the description. i'd love to help with the documentation

Definitely, we are finalizing some minor things about documentation. We will be finalizing by 2nd October. Happy contributing

Thank you

[shatanikmahanty]

@Adelakin-Adewumi I have updated the description. If you want to contribute to this issue, please review and get back to me.

[Adelakin-Adewumi]

@Adelakin-Adewumi I have updated the description. If you want to contribute to this issue, please review and get back to me.

Alright, I will check it and get back to you tomorrow. Thank you.

[Adelakin-Adewumi]

@Adelakin-Adewumi I have updated the description. If you want to contribute to this issue, please review and get back to me.

@shatanikmahanty I'd love to add my knowledge in the documentation if you don't mind. I will contribute the little I can in the readme file if this is okay by you.

[shatanikmahanty]

@Adelakin-Adewumi Go ahead. We will review your PRs and provide feedback so that you make changes if needed

[shatanikmahanty]

@Adelakin-Adewumi just checking in if you are working on this. Please reply to this comment to mark your participation. Reach out to us on community channels if you face issue setting up the project

[Adelakin-Adewumi]

@shatanikmahanty yes, I am. I will definitely reach out if I have an issue. Thank you for checking.

[shatanikmahanty]

@Adelakin-Adewumi unassigned you as there was no activity in the past few months! We look forward to your future contributions! In the mean time if you want any help or want to work on this issue again feel free to ask here!