This was a task request by the project owner @jestemkioskiem, that was posted here. The task request asked for two important documents for the Python Discord bot. Namely:
- An updated
README.mdfile following professional standards. - A full tutorial (excluding the installing of Python libraries) on how to setup and deploy SockoBot to a server, as well as guide on how to start using it. This tutorial has to be submitted in a
HOW_TO_DEPLOY.mdmarkdown file and has to have a consistent, professional format.
Details
I added documentation for the commands that weren't already documented in the README.md file. I also added a tutorial on how to create a Discord application and how to deploy the bot to your Discord server.
Components
For the README.md I added the documentation for the following commands
$convert
and also updated the documentation of the other commands slightly. Furhtermore I added a completely new HOW_TO_DEPLOY.md (see here) where I explain how to create a Discord application and how to deploy SockoBot to your Discord server.
Difference
As mentioned above, I added some new documentation for some of SockBot's commands (see images). You can compare the current README.md with the old version) to see the differences yourself. HOW_TO_DEPLOY.md is brand new documentation, so I can't really compare it with anything.
Links
Posted on Utopian.io - Rewarding Open Source Contributors