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

Create more examples #71

Open
8 tasks
minecrawler opened this issue Oct 2, 2023 · 0 comments
Open
8 tasks

Create more examples #71

minecrawler opened this issue Oct 2, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@minecrawler
Copy link
Collaborator

Going through the README, I sometimes really wish there was a working example script for some explanation. For example "working with states" is mentioned briefly, but it's a rather big deal in any bigger project. The few examples available are great, but the number of example can be expanded to cover more cases.

The only downside is that we (as in myself and my cats - probably) need to maintain all the examples. Hence all the examples should become part of the build pipeline, and all of them should run gracefully for a successful build. At least then I can make sure that I never forget to update any of them. The CI pipeline will catch anything I don't.

A good idea is to go over all parts of the readme and make sure there's an example available and attached. Here's a list of some of my own wishes (in no particular order):

  • Deno sample project (bonus if it's a template)
  • Resources Lifecycle
  • Hot reloading
  • Working with states
  • Actions vs Commands, including break point logic
  • Custom object loaders
  • Custom scheduler logic
  • Trivial network syncing
@minecrawler minecrawler added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Oct 2, 2023
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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant