User-facing Documentation #128
Labels
discussion needed
for when an implementation is uncertain
documentation
Improvements or additions to documentation
major
It would be helpful to have user-facing documentation that could be linked to within the bot so that people don't have to go through pages of
.help x
calls. Hosting this is easy - GitHub pages now allows you to set a folder as a resource to host, so we could just create awebsite
folder for it to work from.Ideally it would be great if we could generate a Markdown file containing all long help strings displayed in one place (so run a script to take all Help pages and spread them out nicely on a website) rather than having to manually edit a page whenever a new feature is introduced. Although we might then want help pages to contain data that is only shown by the website and not the bot (for particularly large examples).
UB3R (https://ub3r-b0t.com/docs/articles/commands.html) provides documentation like this, which may serve as a good starting point for inspiration.
The text was updated successfully, but these errors were encountered: