muse icon indicating copy to clipboard operation
muse copied to clipboard

Documentation how to use the bot and its commands

Open AaronWiora opened this issue 3 years ago • 2 comments

The bot has many different commands and configuration options and for some of them it's obvious how to use them but for others it's not. Slash commands improved the situation but the description might be to short to include all information needed. Here are some examples to make it clearer what I mean:

/favorites create
create a new favorite

I could not find any explanation what a favorite is in the first place.

/config set-wait-after-queue-empties
set the time to wait before leaving the voice channel when queue empties

In which format does muse expect the time for the delay to be? "/fseek" uses "seconds" which makes it a bit clearer what is expected.

The other commands and parameters seem to be self explanatory to me. I would propose to either add the missing information to the built in description as far as that's possible or creating a wiki.

AaronWiora avatar Feb 17 '22 15:02 AaronWiora

Thanks for bringing this up; the documentation is a little lacking in parts.

I'd like to flesh out command descriptions if possible, and fall back to a new section in the README if something needs to be explained further.

Happy to accept a PR with changes. :)

codetheweb avatar Feb 17 '22 23:02 codetheweb

Suggestion: this could go along with a /help command which would DM the user a list of commands.

therithwikrayani avatar Mar 19 '22 10:03 therithwikrayani