yashlamba
docs: Add information about each simulation in the documentation
Under the Simulations tab, make a category wise simulation tab and list all simulations under it. These pages need to describe the simulation as effectively as possible. The content shouldn't be plagiarised.
For setting up docs: https://cod-ed.github.io/simulate/contributing/#setting-up-docs Mkdocs: https://www.mkdocs.org/#getting-started Theme and features: https://squidfunk.github.io/mkdocs-material/
Consider writing about 1 at a time only. This probably will require most amount of discussion.
Hey @yashlamba , I would like to work on this issue. I never used Mkdocs, but I'll do it.
@himanshusharma89 go ahead! Just mention the simulation you are working on.
@yashlamba I'll be working on Bubble Sort, and can I fetch info from Wikipedia. And what would you like to have in the document? Info, Time Complexity, Space Complexity etc.
Hi @himanshusharma89 , sorry for late reply. I don't think we need it for bubble sort as the implementation hasn't been finalized. You can keep the PR open and once we finalize the implementation, you can modify that. Remember if you work on any other of them, it needs to be very detailed and should explain how simulate explains it. Discussion is a must as I mentioned!
Hey, @yashlamba I would like to work on this. Can you please guide me?. I have already set up the project on my machine.
@amanxnanda have you setup the documentation for the project? Refer: https://cod-ed.github.io/simulate/contributing/#setting-up-docs
If done successfully, you can write about any of the simulations which are not documented but write it in your own words. You can let us know which simulation you are working on here or in the Gitter channel.