Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User-facing Documentation #128

Open
finnbar opened this issue Feb 24, 2022 · 0 comments
Open

User-facing Documentation #128

finnbar opened this issue Feb 24, 2022 · 0 comments
Labels
discussion needed for when an implementation is uncertain documentation Improvements or additions to documentation major

Comments

@finnbar
Copy link
Collaborator

finnbar commented Feb 24, 2022

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 a website 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.

@finnbar finnbar added documentation Improvements or additions to documentation major discussion needed for when an implementation is uncertain labels Feb 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion needed for when an implementation is uncertain documentation Improvements or additions to documentation major
Projects
None yet
Development

No branches or pull requests

1 participant