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

[developer] Intermediate guide: Best Practices for EE developers #99

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

[developer] Intermediate guide: Best Practices for EE developers #99

wants to merge 11 commits into from

Conversation

heysokam
Copy link
Contributor

@heysokam heysokam commented Dec 28, 2023 •
edited
Loading

Continuation of #96

List of changes:

  • Remove overview, reformat pre-overview text, merge both
  • Remove gh repo commands, none of the docs use github cli anywhere else
  • Add admonitions to sentences that were more side than core information.
  • Reformat bullet points from -> to how the rest of the docs are formatted.
  • Add better guidelines about bullet point formatting to the readme.
  • Review the wording based on the target reader's skill level profile (intermediate).

todo

  • Write the PlateComponent section
    • PongComponent
    • PongGameSystem
    • PongPhysicsSystem
  • Write the Summary section
  • Expand the content on Best Practices
    • Reactivity on state - separating the what from the how
    • Event sourced state by dispatched actions and receptors
    • Actually reacting to state using effects
    • Decomposing work into separate systems

@heysokam heysokam requested a review from anselm December 28, 2023 21:01
@heysokam heysokam changed the title [developer] Getting Started with Typescript - second pass [developer] Intermediate guide: Best Practices for EE developers Dec 29, 2023
@heysokam heysokam mentioned this pull request Dec 29, 2023
Closed
55 tasks
@heysokam heysokam added documentation Improvements or additions to documentation developer Anything related to the Developers section of the documentation website labels Jan 23, 2024
@heysokam heysokam mentioned this pull request Jan 23, 2024
Closed
1 task
heysokam added a commit that referenced this pull request Jan 30, 2024
@heysokam
rmv: Remove the Pong guide, which is worked on at #99 as intermediate
56e3ae1
DanielBelmes added a commit that referenced this pull request Mar 8, 2024
@heysokam @anselm @DanielBelmes
[developer] Create the beginner Typescript guide (#114)
12dca35 
* typescript breakout

* fmt: Change 00_intro to the new index+nolink system

* fmt: Remove unnecesary folder at docs/ root

* rmv: Remove the Pong guide, which is worked on at #99 as intermediate

* fmt: Restructured the tutorial files/folders/titles

* fmt: Formatting changes to fit the Markdown guidelines

* new: Quickstart sketch

* chg: Turn the confusing install instructions into a simple bash script

* chg: Move installation intro to the intro page

* chg: Move the UbuntuEasyInstall instructions to a partial file

* new: Create the gettingStarted/extras section

* fix: Typo in developer/typescript/start/extras category file

* fix: Remove id from developer/typescript/start/extras category file

* fmt: Move tutorial-basic instructions out of the ubuntu installer file

* new: Add typescript/start/hello section

* chg: Small changes to the hello world tutorial

* fix: Incorrect todo link to the ubuntu install script. rmv: whitespace

* new: Add instructions on how to confirm the hello world installation

* new: Add todo note for explaining the Controlled Context concept

* new: Hello World Tutorial (phase1)

* chg: Improvements to the ECS definitions

* chg: General improvements to the ECS page

* new: Add TechnicalNote custom mdx component

* new: Merge modules+worldInjection into a single file. Write their text

* fmt: Add notes on achieving docusaurus <details> CSS for components

* fmt: Markdown formatting changes for the ECS and Systems pages

* new: Add UnstyledDetails component

* chg: Small wording change in the ECS page

* new: Add source modification section. Improve module imports section

* fix: Small typo in the engine page

* chg: Small typo in the quickstart page

* new: Add the "First System" section text

* fmt: Refactor the folder structure to match the new learning path

* fix: Sidebar ordering numbers

* fmt: Move foreign folders into the _todo temporary subfolder

* fmt: Reorganize the extras folder to build up to networking (sketch)

* requested changes

* chg: Reword `sub-projects` to `projects`

* rmv: Remove test.js from the root folder

* rmv: Remove Entity clarification for its definition

* doc: improve todo note/comment about entity clarification alternatives

* new: Add Congratulations page to the HelloWorld tutorial

* chg: Convert the Extras section into the Basics section

* fix: Missing imports in the new Basics pages

* chg: Congrats and Basics pages formatting improvements

* new: Physics Basics tutorial page

* new: Debugging and Locations Basics tutorial pages sketches

* new: Better instructions on the Physics Basics page

* chg: Small changes to the files

* chg: Wording and instructions changes to the Physics page

* chg: Move locations instructions to the new basics/locations page

* new: Basics/state early sketch (tbd)

* new: Early sketch of the Intermediate tutorials structure

* chg: Cleanup the folders to remove the _todo temporary folder

* chg: Move the Basics tutorial out of Getting Started

* chg: Remove worldInjection instructions

* new: Add HelloWorld/Component page sketch

* chg: Improvements to the HelloWorld/Component page

* fix: Missing UnstyledDetails in the Basics section

* doc: Add todo note to the HelloWorld/components page

* chg: Improvements to the Quickstart guide

* new: Intermediate Section structure/skeleton

* fix: DocCardList on empty Networking category crashed the builder

* chg: Remove leftover mentions to worldInjection

* new: Add code sketch to the HelloComponent page

* fmt: Remove incorrectly added folders

* fix: Broken links and GettingStarted title

* fmt: Small styling changes to the hello/component page

* new: basics/Recap section

* fix: Broken links on Recap and GettingStarted

* chg: Small wording improvements

* new: jsonID naming requirements

* new: Component+Query pages for the HelloWorld guide

* new: Component+Query sketch for the Basics guide

* fix: Ubuntu Installation instructions command

* chg: Edit pass. Small wording changes and fixes for all sections

* new: Basics/component page and Basics/query skeleton

* new: Basics/location creation instructions

* chg: Improve the Basics/query page

* new: Write the Basics/recap/query page

* new: Write the Basics/recap/next page

* new: Add ee-tutorial-hello/Step0 branch instructions

* chg: Add A-to-B overview instructions for the HelloWorld/introduction

* chg: Move modules/engine/testing into typescript/mastery/testing

* chg: Move modules/engine/state to developer/typescript/ecs/state

* new: Create developer/typescript/reactivity section

* chg: Move parts of manual/ecs to the typescript/ecs intermediate guide

* chg: Hello/query editing pass

* fmt: Change Basics/physics to fit the CustomComponent previous code

* chg: Remove noise from the developer/typescript index page

* chg: Basics/state page improvements

* new: Port tldraw list of events to execution order page

* chg: Progress on the Basics/state page

* chg: UX cleanup (phase1)

* chg: UX cleanup (phase2)

* fix: Leftover old code

---------

Co-authored-by: Anselm Hook <[email protected]>
Co-authored-by: Daniel Belmes <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anselm anselm Awaiting requested review from anselm

@HexaField HexaField Awaiting requested review from HexaField

@armando-salazar armando-salazar Awaiting requested review from armando-salazar

Assignees

@anselm anselm

@heysokam heysokam

Labels
developer Anything related to the Developers section of the documentation website documentation Improvements or additions to documentation verified-contributor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@heysokam @anselm