space-wizards / space-wizards/docs
ECS doc is bad and also severely out of date
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 42
- Forks
- 304
- PR merge metrics
- No merged PRs in 30d
Description
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!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the ECS documentation in the docs repository and compare it with how ECS is currently used in the codebase. Review the existing organization and links, then identify the current explanations needed for archetype ECS, relationships, and struct components. Done means the documentation is current, organized, linked to related explainers, and covers those requested concepts.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100