Documentation

[smaranjitghose]

Use Sphinx to document the project in readthedocs format.

Suggested Content:

• The main page should be description of the project
• Detailed Table of contents
• Separate page for contributors
• Dedicated sections for each page of the app with all the necessary cards should be so that anyone with very less or no knowledge of flutter can use this app by changing certain lines of code
• Instructions for Firebase Integration (Don't include the api keys)
• How to update the project from Firebase
• How to build separate Android and IOS Apps
• How to make an .apk file and publish to PlayStore

Push this to gh-pages branch

[CipherGirl]

I would like to work on this as part of GSSoC 20. I'm new to technical writing. Some resources and help from the mentors will be very much appreciated!

[Shadman-Ahmed-Chowdhury]

I am a GSSoC 20 participant. Can I be assigned to this issue?

[smaranjitghose]

@CipherGirl @Shadman-Ahmed-Chowdhury Divide the work among yourself.

Go through the youtube videos on sphinx Documentation (PyCon,Enthought,PyData)

[CipherGirl]

Hello @smaranjitghose, Thank you for assigning to us. I have been setting up the project on my machine and watched some sphinx tutorials also. I have some queries:

• Are we required to know flutter to contribute to this issue?
• We need the initial set up for the docs. The branch 'gh-pages' is not set up. Can you please help us with it?
• Kindly elaborate on this section -> "Dedicated sections for each page of the app with all the necessary cards should be so that anyone with very less or no knowledge of flutter can use this app by changing certain lines of code".

[smaranjitghose]

Hello @smaranjitghose, Thank you for assigning to us. I have been setting up the project on my machine and watched some sphinx tutorials also. I have some queries:

• Are we required to know flutter to contribute to this issue?
• We need the initial set up for the docs. The branch 'gh-pages' is not set up. Can you please help us with it?
• Kindly elaborate on this section -> "Dedicated sections for each page of the app with all the necessary cards should be so that anyone with very less or no knowledge of flutter can use this app by changing certain lines of code".

• Yes you need to understand fundamentals of flutter to write the documentation as you would be explaining the various cards and functions
• I have set up the branch
• Basically the aim of the documentation is to help anyone with no knowledge of flutter or app dev to use this code, make changes in content and assets in certain places of the codebase and use this app as their own