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.

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

[developer] Create the beginner Typescript guide #114

Merged
merged 100 commits into from
Mar 8, 2024
Merged
Changes from 1 commit
Commits
Show all changes
100 commits
Select commit Hold shift + click to select a range
a650393
typescript breakout
anselm Jan 10, 2024
5d4f9c8
Merge branch 'main' into new-TypescriptBeginner
heysokam Jan 30, 2024
4380697
fmt: Change 00_intro to the new index+nolink system
heysokam Jan 30, 2024
3617966
fmt: Remove unnecesary folder at docs/ root
heysokam Jan 30, 2024
56e3ae1
rmv: Remove the Pong guide, which is worked on at #99 as intermediate
heysokam Jan 30, 2024
de485fd
fmt: Restructured the tutorial files/folders/titles
heysokam Jan 30, 2024
4faee3d
fmt: Formatting changes to fit the Markdown guidelines
heysokam Jan 30, 2024
c636682
new: Quickstart sketch
heysokam Jan 31, 2024
be6846b
chg: Turn the confusing install instructions into a simple bash script
heysokam Feb 1, 2024
dfa324a
chg: Move installation intro to the intro page
heysokam Feb 1, 2024
d1f4ea7
Merge branch 'main' into new-TypescriptBeginner
heysokam Feb 1, 2024
2618904
chg: Move the UbuntuEasyInstall instructions to a partial file
heysokam Feb 1, 2024
43f243b
new: Create the gettingStarted/extras section
heysokam Feb 1, 2024
c3cb073
fix: Typo in developer/typescript/start/extras category file
heysokam Feb 1, 2024
dea0af3
fix: Remove id from developer/typescript/start/extras category file
heysokam Feb 1, 2024
4d82dd4
fmt: Move tutorial-basic instructions out of the ubuntu installer file
heysokam Feb 1, 2024
4c52183
new: Add typescript/start/hello section
heysokam Feb 1, 2024
e392085
chg: Small changes to the hello world tutorial
heysokam Feb 2, 2024
208fd70
fix: Incorrect todo link to the ubuntu install script. rmv: whitespace
heysokam Feb 2, 2024
b6972b7
new: Add instructions on how to confirm the hello world installation
heysokam Feb 2, 2024
daa8f5d
new: Add todo note for explaining the Controlled Context concept
heysokam Feb 3, 2024
979d102
new: Hello World Tutorial (phase1)
heysokam Feb 3, 2024
9b52595
chg: Improvements to the ECS definitions
heysokam Feb 6, 2024
cb3dd30
chg: General improvements to the ECS page
heysokam Feb 6, 2024
471712d
new: Add TechnicalNote custom mdx component
heysokam Feb 6, 2024
4b12554
new: Merge modules+worldInjection into a single file. Write their text
heysokam Feb 6, 2024
f41459f
fmt: Add notes on achieving docusaurus <details> CSS for components
heysokam Feb 6, 2024
c771dde
fmt: Markdown formatting changes for the ECS and Systems pages
heysokam Feb 6, 2024
7870779
new: Add UnstyledDetails component
heysokam Feb 6, 2024
c3e9d27
chg: Small wording change in the ECS page
heysokam Feb 6, 2024
a5c25b3
new: Add source modification section. Improve module imports section
heysokam Feb 6, 2024
3b32385
fix: Small typo in the engine page
heysokam Feb 6, 2024
555496a
chg: Small typo in the quickstart page
heysokam Feb 7, 2024
4f10fd0
new: Add the "First System" section text
heysokam Feb 7, 2024
c234a5f
fmt: Refactor the folder structure to match the new learning path
heysokam Feb 7, 2024
4880842
fix: Sidebar ordering numbers
heysokam Feb 7, 2024
6437112
fmt: Move foreign folders into the _todo temporary subfolder
heysokam Feb 7, 2024
b06c363
fmt: Reorganize the extras folder to build up to networking (sketch)
heysokam Feb 8, 2024
96e2b8a
requested changes
heysokam Feb 8, 2024
ad7b558
chg: Reword `sub-projects` to `projects`
heysokam Feb 8, 2024
7f7a999
rmv: Remove test.js from the root folder
heysokam Feb 8, 2024
b91a830
rmv: Remove Entity clarification for its definition
heysokam Feb 8, 2024
25679e0
doc: improve todo note/comment about entity clarification alternatives
heysokam Feb 8, 2024
9e8310c
new: Add Congratulations page to the HelloWorld tutorial
heysokam Feb 8, 2024
4d45fd4
chg: Convert the Extras section into the Basics section
heysokam Feb 8, 2024
149fbfe
fix: Missing imports in the new Basics pages
heysokam Feb 8, 2024
9e86e87
chg: Congrats and Basics pages formatting improvements
heysokam Feb 8, 2024
810af0b
new: Physics Basics tutorial page
heysokam Feb 8, 2024
ea6b41a
new: Debugging and Locations Basics tutorial pages sketches
heysokam Feb 8, 2024
d48a640
new: Better instructions on the Physics Basics page
heysokam Feb 8, 2024
db34134
chg: Small changes to the files
heysokam Feb 9, 2024
1361b68
chg: Wording and instructions changes to the Physics page
heysokam Feb 9, 2024
f9c7d60
chg: Move locations instructions to the new basics/locations page
heysokam Feb 9, 2024
26e55cc
new: Basics/state early sketch (tbd)
heysokam Feb 10, 2024
8dab2aa
new: Early sketch of the Intermediate tutorials structure
heysokam Feb 12, 2024
baa946c
chg: Cleanup the folders to remove the _todo temporary folder
heysokam Feb 13, 2024
e4a3bd4
chg: Move the Basics tutorial out of Getting Started
heysokam Feb 15, 2024
585913c
chg: Remove worldInjection instructions
heysokam Feb 15, 2024
6ce1703
new: Add HelloWorld/Component page sketch
heysokam Feb 15, 2024
e79e0cd
chg: Improvements to the HelloWorld/Component page
heysokam Feb 15, 2024
cfd6e19
fix: Missing UnstyledDetails in the Basics section
heysokam Feb 15, 2024
80b5927
doc: Add todo note to the HelloWorld/components page
heysokam Feb 15, 2024
c2d7fb6
chg: Improvements to the Quickstart guide
heysokam Feb 16, 2024
b7d46e1
new: Intermediate Section structure/skeleton
heysokam Feb 16, 2024
3c10960
fix: DocCardList on empty Networking category crashed the builder
heysokam Feb 16, 2024
92e0054
chg: Remove leftover mentions to worldInjection
heysokam Feb 16, 2024
ecdb568
new: Add code sketch to the HelloComponent page
heysokam Feb 17, 2024
fe3ca7a
Merge branch 'main' into new-TypescriptBeginner
heysokam Feb 21, 2024
b27f56b
fmt: Remove incorrectly added folders
heysokam Feb 21, 2024
9684cd2
fix: Broken links and GettingStarted title
heysokam Feb 21, 2024
2fd8c05
fmt: Small styling changes to the hello/component page
heysokam Feb 22, 2024
fa85c26
new: basics/Recap section
heysokam Feb 22, 2024
9ac5867
fix: Broken links on Recap and GettingStarted
heysokam Feb 23, 2024
38e7ae1
chg: Small wording improvements
heysokam Feb 23, 2024
beaae37
new: jsonID naming requirements
heysokam Feb 23, 2024
d547137
new: Component+Query pages for the HelloWorld guide
heysokam Feb 23, 2024
f7ceaf5
new: Component+Query sketch for the Basics guide
heysokam Feb 23, 2024
8638039
fix: Ubuntu Installation instructions command
heysokam Feb 24, 2024
8852c39
chg: Edit pass. Small wording changes and fixes for all sections
heysokam Feb 24, 2024
ae3f4bd
new: Basics/component page and Basics/query skeleton
heysokam Feb 27, 2024
3f401f1
new: Basics/location creation instructions
heysokam Feb 27, 2024
e800a93
chg: Improve the Basics/query page
heysokam Feb 27, 2024
d14f8c3
new: Write the Basics/recap/query page
heysokam Feb 27, 2024
f8ba519
new: Write the Basics/recap/next page
heysokam Feb 27, 2024
8e6ff27
new: Add ee-tutorial-hello/Step0 branch instructions
heysokam Feb 28, 2024
d6c9d6e
chg: Add A-to-B overview instructions for the HelloWorld/introduction
heysokam Feb 28, 2024
a818f5f
chg: Move modules/engine/testing into typescript/mastery/testing
heysokam Feb 29, 2024
4397999
chg: Move modules/engine/state to developer/typescript/ecs/state
heysokam Feb 29, 2024
4aa8324
new: Create developer/typescript/reactivity section
heysokam Feb 29, 2024
a28c6e9
chg: Move parts of manual/ecs to the typescript/ecs intermediate guide
heysokam Feb 29, 2024
f34053f
chg: Hello/query editing pass
heysokam Feb 29, 2024
aa7d7ae
fmt: Change Basics/physics to fit the CustomComponent previous code
heysokam Mar 1, 2024
c609b2f
chg: Remove noise from the developer/typescript index page
heysokam Mar 1, 2024
c011873
chg: Basics/state page improvements
heysokam Mar 1, 2024
1ac9763
new: Port tldraw list of events to execution order page
heysokam Mar 4, 2024
57024fe
chg: Progress on the Basics/state page
heysokam Mar 4, 2024
e0db654
chg: UX cleanup (phase1)
heysokam Mar 7, 2024
b486715
chg: UX cleanup (phase2)
heysokam Mar 7, 2024
abf1fe5
fix: Leftover old code
heysokam Mar 8, 2024
8d64e49
Merge branch 'main' into new-TypescriptBeginner
DanielBelmes Mar 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: Missing UnstyledDetails in the Basics section
heysokam committed Feb 15, 2024

Verified

This commit was signed with the committer’s verified signature.
Blooym Lyna
commit cfd6e195bcf8f5cd7bc9a97a9adf90cd3bc32b23
5 changes: 3 additions & 2 deletions docs/developer/typescript/02_basics/01_physics.md
Original file line number Diff line number Diff line change
@@ -2,6 +2,7 @@
sidebar_label: Physics
---
import { TechnicalNote } from '@site/src/components/TechnicalNote';
import { UnstyledDetails } from '@site/src/components/UnstyledDetails';

# Adding Physics
So far we have learned how to create an `Entity`, and how to tell the engine what we want our entity to be.
@@ -68,7 +69,7 @@ ECS.setComponent(entity, ColliderComponent, { shape: 'sphere' })
ECS.setComponent(entity, TransformComponent, { position: new Vector3(0, 3, 0) })
```

<TechnicalNote title="Full Solution">
<UnstyledDetails title="Full Solution">

```ts
import { ECS } from '@etherealengine/ecs'
@@ -113,7 +114,7 @@ export const HelloWorldSystem = ECS.defineSystem({

export default async function worldInjection() {}
```
</TechnicalNote>
</UnstyledDetails>
<!-- Full Solution End -->
</TechnicalNote>
<!-- Solution End -->
5 changes: 4 additions & 1 deletion docs/developer/typescript/02_basics/03_loop.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { TechnicalNote } from '@site/src/components/TechnicalNote';
import { UnstyledDetails } from '@site/src/components/UnstyledDetails';

# Engine Loop
<!--
@@ -7,5 +8,7 @@ Write something that happens every tick
Write something that happens every frame
-->

<TechnicalNote title="Full Solution">
<TechnicalNote title="Solution">
<UnstyledDetails title="Full Solution">
</UnstyledDetails>
</TechnicalNote>
5 changes: 4 additions & 1 deletion docs/developer/typescript/02_basics/60_networking.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import { TechnicalNote } from '@site/src/components/TechnicalNote';
import { UnstyledDetails } from '@site/src/components/UnstyledDetails';

# Networking


<TechnicalNote title="Full Solution">
<TechnicalNote title="Solution">
<UnstyledDetails title="Full Solution">

```ts
import React, { useEffect } from 'react'
@@ -150,5 +152,6 @@ export const BasicSystem = defineSystem({
insert: { after: PresentationSystemGroup }
})
```
</UnstyledDetails>
</TechnicalNote>