SGA-A / c2c

Source code for the custom app exclusive to cc, where most interactions begin and end.
MIT License
0 stars 0 forks source link

Better the beginner experience #141

Open SGA-A opened 1 month ago

SGA-A commented 1 month ago

Is your feature request related to a problem? Please describe.

When the bot registers a new user or is added to a new server, it would be nice if it actually introduced itself and explained what just happened rather than doing nothing. We want to make it more recognizable for users to find what they want to do in the economy system and/or with the bot.

Therefore, we want to add a lot of help features that are designed with the aim of making the interface seem less overwhelming and with step by step guides and tutorials.

Describe the solution you'd like

Some rules to follow when implementing these guides:

  1. Tailor the complexity and detail of your explanations accordingly, with the assumption that they no nothing about what this guide is about
  2. Outline the topics you will cover, like a text book
  3. Use simple, straightforward sentences, avoid massive text blocks
  4. Add screenshots, if provided the possibility, to illustrate each step. Ensure visuals are clear and directly related to the text
  5. Use bold or italics to emphasize key points or warnings
  6. Include tips or notes for additional context
  7. Follow your own instructions to ensure they are accurate and complete, things may be get outdated over time
  8. Include a FAQ section if applicable
  9. Use a consistent formatting principle
  10. Proofread for spelling and grammar errors
  11. Revise any unclear or ambiguous instructions
  12. Use the Discord Bot UI Kit (views) wherever possible

Features we want to include are:

This one is not included because it would require a huge rewrite. But it involves 'viewifying' the help command we've currently got. We want to return to our roots and display all commands, including slash commands. If we're gonna do it, we might as well do it good because this is what people will be seeing most often.

The process of it'll work will be discussed another time.

SGA-A commented 1 month ago

This is not a duplicate of #133, rather it undoes the damage that was created both before and after the commits made to resolve the issue.