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

Better the beginner experience #141

Open
5 tasks
geoversed opened this issue Jul 21, 2024 · 2 comments
Open
5 tasks

Better the beginner experience #141

geoversed opened this issue Jul 21, 2024 · 2 comments
Assignees
Labels
docs Improvements or additions to documentation. economy Relevant to the economy system. feature This is a feature request.

Comments

@geoversed
Copy link
Owner

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:

  • Some response that is sent whenever a user is registered, and can also be accessed through a command, entailing what you can do in the economy system
  • Some response that is sent when the bot joins a server to guide the user as to what the bot can do
  • A command that does what the tips setting is for (equivalent to /help tip)
  • More in depth guides on specific commands on first use
    • This can be done by making use of the __doc__ attribute in all command callbacks.
  • Guides for commands/functionality that is more advanced in nature on the wiki for this repo

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.

@geoversed geoversed added the feature This is a feature request. label Jul 21, 2024
@geoversed geoversed self-assigned this Jul 21, 2024
@geoversed geoversed moved this to Backlog in c2c Development Jul 21, 2024
@geoversed
Copy link
Owner Author

geoversed commented Jul 21, 2024

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.

@geoversed geoversed added docs Improvements or additions to documentation. economy Relevant to the economy system. planned labels Jul 24, 2024
@geoversed geoversed mentioned this issue Sep 22, 2024
4 tasks
@geoversed geoversed removed the planned label Oct 16, 2024
@geoversed
Copy link
Owner Author

Worth considering GitBook to display more in depth documentation for the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation. economy Relevant to the economy system. feature This is a feature request.
Projects
Status: Backlog
Development

No branches or pull requests

1 participant