space-wizards/docs

ECS doc is bad and also severely out of date

Opened this issue · 1 comments

its super all over the place and disorganized, doesn't explain much about how ECS is actually used in the codebase, needs more links to other explainers, and general updating for the current state of the codebase

  • probably needs explainers on archetype ECS / relationships / struct comps since we are getting that very soon with arch!

IMO:
This document has a lot of character which is distracting.
If I where to alter/re-write it this would be my list of targets

  • ECS doc should be split up into multiple parts. ECS, ECS + Events, FAQ
    • If FAQ is known it should be integrated into the doc on a re-wright
  • Sort out the word soup (mostly the "todo" section oop section)
    anti OOP rhetoric obscures the main point: Constrained Programing
  • out of order examples: events are introduced too early just so code can be shown on screen
  • remove first person and favor third or second person (exclusive)
    • remove exclamations
    • remove narration
  • remove rhetorical questions