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

ECS doc is bad and also severely out of date #15

Open
mirrorcult opened this issue Sep 21, 2023 · 1 comment · May be fixed by #343
Open

ECS doc is bad and also severely out of date #15

mirrorcult opened this issue Sep 21, 2023 · 1 comment · May be fixed by #343
Labels
Engine Relevant to documentation of Robust Toolbox-specific code, not content. !! IMPORTANT !! HIGH URGENCY. HELP Out of Date Relevant to pages which just need to be updated rather than rewritten or added.

Comments

@mirrorcult
Copy link
Contributor

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!
@mirrorcult mirrorcult added Engine Relevant to documentation of Robust Toolbox-specific code, not content. Out of Date Relevant to pages which just need to be updated rather than rewritten or added. !! IMPORTANT !! HIGH URGENCY. HELP labels Sep 21, 2023
@Jezithyr Jezithyr closed this as completed Mar 4, 2024
@Jezithyr Jezithyr reopened this Mar 4, 2024
@Jezithyr Jezithyr mentioned this issue Mar 4, 2024
Closed
@benev0
Copy link

benev0 commented Oct 21, 2024

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

@benev0 benev0 linked a pull request Nov 11, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Engine Relevant to documentation of Robust Toolbox-specific code, not content. !! IMPORTANT !! HIGH URGENCY. HELP Out of Date Relevant to pages which just need to be updated rather than rewritten or added.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

RT ECS docs rewrite benev0/docs-space
3 participants
@Jezithyr @mirrorcult @benev0