jeffcampbellmakesgames / Entitas-Redux

An entity-component framework for Unity with code generation and visual debugging
MIT License
103 stars 13 forks source link

[FEATURE REQUEST] Add documentation for existing features #1

Closed jeffcampbellmakesgames closed 3 years ago

jeffcampbellmakesgames commented 4 years ago

Is your feature request related to a problem? Please describe. As of right now, the only existing documentation for the ECS portions of EntitasRedux can be found by looking at the original Entitas wiki here. Even so, not every aspect of the original Entitas was covered. This can make it difficult for new users to jump in and understand EntitasRedux workflows and concepts.

Describe the solution you'd like

I'd like for documentation to be created such that covers all of the code generation and ECS concepts of EntitasRedux. These docs should be available online and in some form as a PDF included with the package so that a user can open it locally. Menu items should be added to make it easy to open both the local PDF and a browser link to the online docs. If possible, API docs should be auto-generated from code so that it is easy to search the API.

Concepts Covered

Other

jeffcampbellmakesgames commented 4 years ago

I've added a wiki for the repo and stubbed out a lot of the topics needed to be covered here. I've also generated a static site for the scripting API that can be found here.

jeffcampbellmakesgames commented 4 years ago

Added documentation for contexts here and added brief descriptions of each concept here.

jeffcampbellmakesgames commented 4 years ago

Added a bunch more documentation for various component attributes and code gen here.

jeffcampbellmakesgames commented 4 years ago

Finished up the attributes doc and created it on the wiki here.

jeffcampbellmakesgames commented 3 years ago

Closing this issue as it has been replaced with individual issues