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

Add more term definitions #256

Open
CarrotManMatt opened this issue Jul 12, 2024 · 0 comments · May be fixed by #319
Open

Add more term definitions #256

CarrotManMatt opened this issue Jul 12, 2024 · 0 comments · May be fixed by #319
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@CarrotManMatt
Copy link
Member

CarrotManMatt commented Jul 12, 2024

The dictionary for definition of commonly used terms is getting rather large. I propose that it is moved into a separate, standalone documentation file. A message should then be placed at the top of the README.md, stating that readers should familiarise themselves with all the defined terms before continuing reading (to prevent confusion).

In addition, the terms "command", "event", "interaction", "event listener" and "task" should have definitions added to that new documentation file, alongside the moved definitions from the README.md

@CarrotManMatt CarrotManMatt added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 12, 2024
@CarrotManMatt CarrotManMatt linked a pull request Dec 24, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant