search

grapheo12 / iqps

Web-app meant for qp.metakgp.org
MIT License
20 stars 21 forks source link

Update docs #4

Open grapheo12 opened 4 years ago

grapheo12 commented 4 years ago

There has been some changes to the Login system and UI. Also a new feature of reporting inappropriate links has been added. So docs and the associated screenshots need to be changed.

Also we need to add a Contributing guidelines and issue template.

sahil-shubham commented 3 years ago

Hey @grapheo12 , I would like to work on this issue. Is it available?

grapheo12 commented 3 years ago

@sahil-shubham Always has been.

grapheo12 commented 3 years ago

@skkarn21 You are assigned to this issue. Your main task will be to scan through the docs' Usage and Admin Roles section, use the application yourself, and then find if there is any discrepancy between the two. The screenshots need an update. But that will be done after the completion of #33. Also, you can contact someone who installed the app in Windows and document the steps they had to take (in excess of what has been already documented.

grapheo12 commented 3 years ago

Please self-assign yourself so that I get to know you have started working.

grapheo12 commented 3 years ago

We use sphinx for documentation. Make sure you compile the docs before committing.

Read: https://www.sphinx-doc.org/en/master/

skkarn21 commented 3 years ago

Ok but I am not able to self assign myself.