From ce3ae5034cf332dc1b34c1f63ffc85d7b164d0c2 Mon Sep 17 00:00:00 2001 From: Armando Salazar <121046819+armando-salazar@users.noreply.github.com> Date: Thu, 28 Mar 2024 06:18:23 -0400 Subject: [PATCH 1/3] [all] Write the Manual's introduction page (sketch) (#153) --- docs/manual/manual.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/manual/manual.md b/docs/manual/manual.md index c3f80bd789dd..27713f91725b 100644 --- a/docs/manual/manual.md +++ b/docs/manual/manual.md @@ -1,7 +1,16 @@ --- sidebar_position: 00 --- -# Ethereal Engine Manual - - -Learn everything that Ethereal Engine has to offer. + +# iR Engine Manual + +Use this Manual to learn how to use the iR Engine to develop real-time 3D web experiences. It covers installation instructions and guides you through the engine and its features. + +This site serves as a reference for understanding complex concepts and configurations for your projects. Learn about the engine's components and advanced settings to enhance your experience. + +## Guides and tutorials + +For specific tutorials and guides, refer to: + +- [Become a Creator](https://etherealengine.github.io/etherealengine-docs/creator): Tutorials for using the engine's **Studio** to build metaverse experiences. +- [Typescript guides](https://etherealengine.github.io/etherealengine-docs/developer/typescript): Guides for developers using Typescript with the iR Engine. From a53be7f95d81b12140e2c69932b873ab44fa19a2 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Wed, 3 Apr 2024 14:24:57 +0200 Subject: [PATCH 2/3] chg: /developer/typescript restructure based on review (#149) Co-authored-by: Armando Salazar <121046819+armando-salazar@users.noreply.github.com> --- docs/developer/typescript/02_basics/03_state.md | 6 ++++++ .../01_dataDriven/01_logicData.md | 16 ++++++++++++++++ .../03_beyondBasics/01_dataDriven/50_state.md | 7 ------- .../50_reactivity.md} | 0 .../typescript/04_state/50_reactors.md | 5 +++++ .../01_state.md => 04_state/50_state.md} | 1 + .../{04_ecs => 04_state}/_category_.yml | 0 docs/developer/typescript/04_state/index.md | 17 +++++++++++++++++ .../01_components/_category_.yml | 0 .../{04_ecs => 05_ecs}/01_components/index.md | 0 .../02_systems/50_order/01_input.md | 0 .../02_systems/50_order/02_simulation.md | 0 .../02_systems/50_order/03_animation.md | 0 .../02_systems/50_order/04_presentation.md | 0 .../02_systems/50_order/_category_.yml | 0 .../02_systems/50_order/index.md | 0 .../02_systems/_category_.yml | 0 .../{04_ecs => 05_ecs}/02_systems/index.md | 0 .../03_queries/_category_.yml | 0 .../{04_ecs => 05_ecs}/03_queries/index.md | 0 .../04_reactors/_category_.yml | 0 .../{04_ecs => 05_ecs}/04_reactors/index.md | 0 .../05_eventSourcing/_category_.yml | 0 .../05_eventSourcing/index.md | 0 docs/developer/typescript/05_ecs/_category_.yml | 1 + .../typescript/{04_ecs => 05_ecs}/index.md | 0 .../typescript/40_inputs/01_spatial.md | 5 +++++ .../40_inputs/02_interactionSystem.md | 5 +++++ .../typescript/40_inputs/03_grabbables.md | 5 +++++ .../typescript/40_physics/50_triggers.md | 9 +++++++++ .../_category_.yml | 0 docs/developer/typescript/40_physics/index.md | 8 ++++++++ .../developer/typescript/40_reactivity/index.md | 10 ---------- 33 files changed, 78 insertions(+), 17 deletions(-) create mode 100644 docs/developer/typescript/03_beyondBasics/01_dataDriven/01_logicData.md delete mode 100644 docs/developer/typescript/03_beyondBasics/01_dataDriven/50_state.md rename docs/developer/typescript/{40_reactivity/02_reactors.md => 04_state/50_reactivity.md} (100%) create mode 100644 docs/developer/typescript/04_state/50_reactors.md rename docs/developer/typescript/{40_reactivity/01_state.md => 04_state/50_state.md} (99%) rename docs/developer/typescript/{04_ecs => 04_state}/_category_.yml (100%) create mode 100644 docs/developer/typescript/04_state/index.md rename docs/developer/typescript/{04_ecs => 05_ecs}/01_components/_category_.yml (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/01_components/index.md (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/02_systems/50_order/01_input.md (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/02_systems/50_order/02_simulation.md (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/02_systems/50_order/03_animation.md (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/02_systems/50_order/04_presentation.md (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/02_systems/50_order/_category_.yml (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/02_systems/50_order/index.md (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/02_systems/_category_.yml (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/02_systems/index.md (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/03_queries/_category_.yml (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/03_queries/index.md (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/04_reactors/_category_.yml (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/04_reactors/index.md (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/05_eventSourcing/_category_.yml (100%) rename docs/developer/typescript/{04_ecs => 05_ecs}/05_eventSourcing/index.md (100%) create mode 100644 docs/developer/typescript/05_ecs/_category_.yml rename docs/developer/typescript/{04_ecs => 05_ecs}/index.md (100%) create mode 100644 docs/developer/typescript/40_inputs/01_spatial.md create mode 100644 docs/developer/typescript/40_inputs/02_interactionSystem.md create mode 100644 docs/developer/typescript/40_inputs/03_grabbables.md create mode 100644 docs/developer/typescript/40_physics/50_triggers.md rename docs/developer/typescript/{40_reactivity => 40_physics}/_category_.yml (100%) create mode 100644 docs/developer/typescript/40_physics/index.md delete mode 100644 docs/developer/typescript/40_reactivity/index.md diff --git a/docs/developer/typescript/02_basics/03_state.md b/docs/developer/typescript/02_basics/03_state.md index 6e13c6e59fbd..a2aa6064396a 100644 --- a/docs/developer/typescript/02_basics/03_state.md +++ b/docs/developer/typescript/02_basics/03_state.md @@ -2,6 +2,12 @@ sidebar_label: State --- + + import { TechnicalNote } from '@site/src/components/TechnicalNote'; # State Management diff --git a/docs/developer/typescript/03_beyondBasics/01_dataDriven/01_logicData.md b/docs/developer/typescript/03_beyondBasics/01_dataDriven/01_logicData.md new file mode 100644 index 000000000000..816315b04008 --- /dev/null +++ b/docs/developer/typescript/03_beyondBasics/01_dataDriven/01_logicData.md @@ -0,0 +1,16 @@ +--- +draft: true +--- + +# Logic vs Data + diff --git a/docs/developer/typescript/03_beyondBasics/01_dataDriven/50_state.md b/docs/developer/typescript/03_beyondBasics/01_dataDriven/50_state.md deleted file mode 100644 index 4ce4726666a7..000000000000 --- a/docs/developer/typescript/03_beyondBasics/01_dataDriven/50_state.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -draft: true ---- - -# State Management -- [ ] State management -- [ ] New synchronous state API diff --git a/docs/developer/typescript/40_reactivity/02_reactors.md b/docs/developer/typescript/04_state/50_reactivity.md similarity index 100% rename from docs/developer/typescript/40_reactivity/02_reactors.md rename to docs/developer/typescript/04_state/50_reactivity.md diff --git a/docs/developer/typescript/04_state/50_reactors.md b/docs/developer/typescript/04_state/50_reactors.md new file mode 100644 index 000000000000..3d449af78901 --- /dev/null +++ b/docs/developer/typescript/04_state/50_reactors.md @@ -0,0 +1,5 @@ +--- +draft: true +--- + +# Reactors diff --git a/docs/developer/typescript/40_reactivity/01_state.md b/docs/developer/typescript/04_state/50_state.md similarity index 99% rename from docs/developer/typescript/40_reactivity/01_state.md rename to docs/developer/typescript/04_state/50_state.md index c0ca463a5414..b23275b088d0 100644 --- a/docs/developer/typescript/40_reactivity/01_state.md +++ b/docs/developer/typescript/04_state/50_state.md @@ -2,6 +2,7 @@ draft: true --- + # State Management All of Ethereal Engine's state management uses [Hookstate](https://hookstate.js.org/) and [React](https://react.dev/). Together, these tools give reactive, declarative, and controlled state management across any scope. diff --git a/docs/developer/typescript/04_ecs/_category_.yml b/docs/developer/typescript/04_state/_category_.yml similarity index 100% rename from docs/developer/typescript/04_ecs/_category_.yml rename to docs/developer/typescript/04_state/_category_.yml diff --git a/docs/developer/typescript/04_state/index.md b/docs/developer/typescript/04_state/index.md new file mode 100644 index 000000000000..8bbe296b6d11 --- /dev/null +++ b/docs/developer/typescript/04_state/index.md @@ -0,0 +1,17 @@ +--- +draft: true +--- + +import DocCardList from '@theme/DocCardList' + +# State Management + + + diff --git a/docs/developer/typescript/04_ecs/01_components/_category_.yml b/docs/developer/typescript/05_ecs/01_components/_category_.yml similarity index 100% rename from docs/developer/typescript/04_ecs/01_components/_category_.yml rename to docs/developer/typescript/05_ecs/01_components/_category_.yml diff --git a/docs/developer/typescript/04_ecs/01_components/index.md b/docs/developer/typescript/05_ecs/01_components/index.md similarity index 100% rename from docs/developer/typescript/04_ecs/01_components/index.md rename to docs/developer/typescript/05_ecs/01_components/index.md diff --git a/docs/developer/typescript/04_ecs/02_systems/50_order/01_input.md b/docs/developer/typescript/05_ecs/02_systems/50_order/01_input.md similarity index 100% rename from docs/developer/typescript/04_ecs/02_systems/50_order/01_input.md rename to docs/developer/typescript/05_ecs/02_systems/50_order/01_input.md diff --git a/docs/developer/typescript/04_ecs/02_systems/50_order/02_simulation.md b/docs/developer/typescript/05_ecs/02_systems/50_order/02_simulation.md similarity index 100% rename from docs/developer/typescript/04_ecs/02_systems/50_order/02_simulation.md rename to docs/developer/typescript/05_ecs/02_systems/50_order/02_simulation.md diff --git a/docs/developer/typescript/04_ecs/02_systems/50_order/03_animation.md b/docs/developer/typescript/05_ecs/02_systems/50_order/03_animation.md similarity index 100% rename from docs/developer/typescript/04_ecs/02_systems/50_order/03_animation.md rename to docs/developer/typescript/05_ecs/02_systems/50_order/03_animation.md diff --git a/docs/developer/typescript/04_ecs/02_systems/50_order/04_presentation.md b/docs/developer/typescript/05_ecs/02_systems/50_order/04_presentation.md similarity index 100% rename from docs/developer/typescript/04_ecs/02_systems/50_order/04_presentation.md rename to docs/developer/typescript/05_ecs/02_systems/50_order/04_presentation.md diff --git a/docs/developer/typescript/04_ecs/02_systems/50_order/_category_.yml b/docs/developer/typescript/05_ecs/02_systems/50_order/_category_.yml similarity index 100% rename from docs/developer/typescript/04_ecs/02_systems/50_order/_category_.yml rename to docs/developer/typescript/05_ecs/02_systems/50_order/_category_.yml diff --git a/docs/developer/typescript/04_ecs/02_systems/50_order/index.md b/docs/developer/typescript/05_ecs/02_systems/50_order/index.md similarity index 100% rename from docs/developer/typescript/04_ecs/02_systems/50_order/index.md rename to docs/developer/typescript/05_ecs/02_systems/50_order/index.md diff --git a/docs/developer/typescript/04_ecs/02_systems/_category_.yml b/docs/developer/typescript/05_ecs/02_systems/_category_.yml similarity index 100% rename from docs/developer/typescript/04_ecs/02_systems/_category_.yml rename to docs/developer/typescript/05_ecs/02_systems/_category_.yml diff --git a/docs/developer/typescript/04_ecs/02_systems/index.md b/docs/developer/typescript/05_ecs/02_systems/index.md similarity index 100% rename from docs/developer/typescript/04_ecs/02_systems/index.md rename to docs/developer/typescript/05_ecs/02_systems/index.md diff --git a/docs/developer/typescript/04_ecs/03_queries/_category_.yml b/docs/developer/typescript/05_ecs/03_queries/_category_.yml similarity index 100% rename from docs/developer/typescript/04_ecs/03_queries/_category_.yml rename to docs/developer/typescript/05_ecs/03_queries/_category_.yml diff --git a/docs/developer/typescript/04_ecs/03_queries/index.md b/docs/developer/typescript/05_ecs/03_queries/index.md similarity index 100% rename from docs/developer/typescript/04_ecs/03_queries/index.md rename to docs/developer/typescript/05_ecs/03_queries/index.md diff --git a/docs/developer/typescript/04_ecs/04_reactors/_category_.yml b/docs/developer/typescript/05_ecs/04_reactors/_category_.yml similarity index 100% rename from docs/developer/typescript/04_ecs/04_reactors/_category_.yml rename to docs/developer/typescript/05_ecs/04_reactors/_category_.yml diff --git a/docs/developer/typescript/04_ecs/04_reactors/index.md b/docs/developer/typescript/05_ecs/04_reactors/index.md similarity index 100% rename from docs/developer/typescript/04_ecs/04_reactors/index.md rename to docs/developer/typescript/05_ecs/04_reactors/index.md diff --git a/docs/developer/typescript/04_ecs/05_eventSourcing/_category_.yml b/docs/developer/typescript/05_ecs/05_eventSourcing/_category_.yml similarity index 100% rename from docs/developer/typescript/04_ecs/05_eventSourcing/_category_.yml rename to docs/developer/typescript/05_ecs/05_eventSourcing/_category_.yml diff --git a/docs/developer/typescript/04_ecs/05_eventSourcing/index.md b/docs/developer/typescript/05_ecs/05_eventSourcing/index.md similarity index 100% rename from docs/developer/typescript/04_ecs/05_eventSourcing/index.md rename to docs/developer/typescript/05_ecs/05_eventSourcing/index.md diff --git a/docs/developer/typescript/05_ecs/_category_.yml b/docs/developer/typescript/05_ecs/_category_.yml new file mode 100644 index 000000000000..93ad1cc4c675 --- /dev/null +++ b/docs/developer/typescript/05_ecs/_category_.yml @@ -0,0 +1 @@ +position: 05 diff --git a/docs/developer/typescript/04_ecs/index.md b/docs/developer/typescript/05_ecs/index.md similarity index 100% rename from docs/developer/typescript/04_ecs/index.md rename to docs/developer/typescript/05_ecs/index.md diff --git a/docs/developer/typescript/40_inputs/01_spatial.md b/docs/developer/typescript/40_inputs/01_spatial.md new file mode 100644 index 000000000000..1d0282335ee9 --- /dev/null +++ b/docs/developer/typescript/40_inputs/01_spatial.md @@ -0,0 +1,5 @@ +--- +draft: true +--- + +# Spatial Inputs diff --git a/docs/developer/typescript/40_inputs/02_interactionSystem.md b/docs/developer/typescript/40_inputs/02_interactionSystem.md new file mode 100644 index 000000000000..ab0e979c2fac --- /dev/null +++ b/docs/developer/typescript/40_inputs/02_interactionSystem.md @@ -0,0 +1,5 @@ +--- +draft: true +--- + +# Interaction System diff --git a/docs/developer/typescript/40_inputs/03_grabbables.md b/docs/developer/typescript/40_inputs/03_grabbables.md new file mode 100644 index 000000000000..ffa7461f20c2 --- /dev/null +++ b/docs/developer/typescript/40_inputs/03_grabbables.md @@ -0,0 +1,5 @@ +--- +draft: true +--- + +# Grabbables diff --git a/docs/developer/typescript/40_physics/50_triggers.md b/docs/developer/typescript/40_physics/50_triggers.md new file mode 100644 index 000000000000..2fb2b7e5588f --- /dev/null +++ b/docs/developer/typescript/40_physics/50_triggers.md @@ -0,0 +1,9 @@ +--- +draft: true +--- + +# Triggers + + diff --git a/docs/developer/typescript/40_reactivity/_category_.yml b/docs/developer/typescript/40_physics/_category_.yml similarity index 100% rename from docs/developer/typescript/40_reactivity/_category_.yml rename to docs/developer/typescript/40_physics/_category_.yml diff --git a/docs/developer/typescript/40_physics/index.md b/docs/developer/typescript/40_physics/index.md new file mode 100644 index 000000000000..735b6c32c1cc --- /dev/null +++ b/docs/developer/typescript/40_physics/index.md @@ -0,0 +1,8 @@ +--- +draft: true +--- + +# Physics + diff --git a/docs/developer/typescript/40_reactivity/index.md b/docs/developer/typescript/40_reactivity/index.md deleted file mode 100644 index 6a5cd303b4cb..000000000000 --- a/docs/developer/typescript/40_reactivity/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -draft: true ---- - -import DocCardList from '@theme/DocCardList' - -# Reactivity - - - From 3602d7830d71e979f8c08596362fb22f042e12e5 Mon Sep 17 00:00:00 2001 From: Daniel Belmes <3631206+DanielBelmes@users.noreply.github.com> Date: Wed, 3 Apr 2024 12:30:52 -0700 Subject: [PATCH 3/3] [devops] fix: change version until docu 3.2 is fixed (#160) --- package.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index d5a5f0a1e586..3cebbf5d4378 100644 --- a/package.json +++ b/package.json @@ -28,8 +28,8 @@ "react": "^18.2.0" }, "dependencies": { - "@docusaurus/core": "^3.1.1", - "@docusaurus/preset-classic": "^3.1.1", + "@docusaurus/core": "3.1.0", + "@docusaurus/preset-classic": "3.1.0", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", "prism-react-renderer": "^2.3.0", @@ -37,9 +37,9 @@ "react-dom": "^18.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "^3.1.1", - "@docusaurus/tsconfig": "^3.1.1", - "@docusaurus/types": "^3.1.1", + "@docusaurus/module-type-aliases": "3.1.0", + "@docusaurus/tsconfig": "3.1.0", + "@docusaurus/types": "3.1.0", "@ocular-d/vale-bin": "^2.29.6", "@tsconfig/docusaurus": "1.0.7", "@types/node": "^20.10.3",