Optimize the documentation and the getting started guide

[TheJoin95]

• getting started
• how to install the pip package
• show some code examples
• api documentation to run on a private server
• heroku api documentation
• cli documentation
• troubleshooting

[ffex]

Hey! if you want I can help with this! can you assign me?

[TheJoin95]

Yep, sure! Thanks

[ffex]

I have a few question: where can I write this things? in the readme? or direct in the docs folder?
Any suggestion or ideas to start? 😁

[TheJoin95]

You can create a doc folder or a .MD file, e.g. DOCUMENTATION.md in the root folder.

On the website, ign.schrodinger-hat.it, there is a documentation page. It's just for the python library but you can have at least a reference :)

[ffex]

ok! thanks!

[Wabri]

@ffex are you still working on it? I will remove the assignment if not!

[aakashvaa]

@Wabri can i work on this issue ? maybe i will ask too questions because i'm new to open source .

show some code examples
api documentation to run on a private server
cli documentation
troubleshooting

for these headings where can i get to know more about this term and details so i can make sure to prepare myself for better documentation .

[Wabri]

Hi @akaashvaa, of course you can. Right now this project is in a stalemate, but we are considering on getting back into it.

If you have any question, just ping us here or in the discord server.

[aakashvaa]

@Wabri thankuu , can u please send me the discord link ?

Hi @akaashvaa, of course you can. Right now this project is in a stalemate, but we are considering on getting back into it.

If you have any question, just ping us here or in the discord server.

thankuu , can u please drop the discord link ?

[TheJoin95]

@akaashvaa https://discord.gg/RTXr8A3eFn