Before an official release, we definitely need more of a documentation (mainly wiki + readme).
This can only be done once the API and user interface is finalized.
What needs to be done (up to debate):
[x] A thorough explanation on how to get started #57
[x] On the readme, add links such as "I am a server owner, how do I add this bot", "I want to host this bot", "I am a plugin developer, how do I create my own plugin"
[x] Each link points to its own wiki page which will help you in that specific context
[x] We can, on each of those pages, link to more general pages like the naming conventions and installation for developers, dashboard help for managing the bot, etc. Handled directly on the readme.
[ ] Screenshot(s) of the dashboard
[ ] Video tutorial for installation and basic usage (including creating the Discord application and bot)
[ ] Code of conduct
[ ] PR template
[ ] Issue template
[ ] Contributing guidelines
[ ] Best coding practices (e.g. how/when to use the WebAPI, don't add a million npm dependencies just because you feel like it, ...)
[x] Readme: make Discord server badge clickable (make it open the server invite link) #57
Before an official release, we definitely need more of a documentation (mainly wiki + readme).
This can only be done once the API and user interface is finalized.
What needs to be done (up to debate):
We can, on each of those pages, link to more general pages like the naming conventions and installation for developers, dashboard help for managing the bot, etc.Handled directly on the readme.