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.

Sign up for GitHub

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

Jump to bottom

[2.0] Documentation Refresh #189

Open
5 of 11 tasks
hmans opened this issue Oct 15, 2022 · 0 comments
Open
5 of 11 tasks

[2.0] Documentation Refresh #189

hmans opened this issue Oct 15, 2022 · 0 comments
Assignees
@hmans
Labels
documentation Improvements or additions to documentation
Milestone
Miniplex 2.0.0

Comments

@hmans
Copy link
Owner

hmans commented Oct 15, 2022 •
edited
Loading

  • Update existing README to reflect new bits
  • Provide a summary example at the top of the README
  • Add links to codesandbox and stackblitz sandboxes with the demo game
  • Describe/document the demos
  • Document world.archetype
  • Document without
  • Document the where iterator generator
  • Document generics of archetype, with, without and where
  • Document typical pitfalls (like world.with("foo").without("bar") vs. world.without("bar").with("foo"))
  • Add a "How It Works" section that explains buckets etc.
  • Add a section on performance
@hmans hmans added this to the Miniplex 2.0.0 milestone Oct 15, 2022
@hmans hmans self-assigned this Oct 15, 2022
@hmans hmans added the documentation Improvements or additions to documentation label Oct 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hmans hmans

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Miniplex 2.0.0
Development

No branches or pull requests
1 participant
@hmans