From 7b6290feb7d86d26e8edb5a91e4083dd0ec95c39 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 26 Mar 2024 11:35:30 +0100 Subject: [PATCH 01/33] new: `Creator` & `Visualscript` Meta-Structure folder skeleton --- docs/creator/01_gettingStarted/01_quickstart.md | 8 ++++++++ .../01_gettingStarted/02_hello/_category_.yml | 1 + .../creator/01_gettingStarted/02_hello/index.md | 9 +++++++++ docs/creator/01_gettingStarted/index.md | 6 +----- .../{01_gettingStarted => 02_basics}/01_file.md | 0 .../02_file2.md | 0 .../creator/02_basics/70_project/_category_.yml | 1 + docs/creator/02_basics/70_project/index.md | 13 +++++++++++++ docs/creator/02_basics/_category_.yml | 1 + docs/creator/02_basics/index.md | 17 +++++++++++++++++ .../{02_topic1 => 03_beyondBasics}/01_file.md | 0 .../{02_topic1 => 03_beyondBasics}/02_file2.md | 0 docs/creator/03_beyondBasics/_category_.yml | 1 + .../{02_topic1 => 03_beyondBasics}/index.md | 2 +- .../{03_topic2 => 60_mastery}/01_file.md | 0 .../{03_topic2 => 60_mastery}/02_file2.md | 0 docs/creator/60_mastery/_category_.yml | 1 + docs/creator/60_mastery/index.md | 15 +++++++++++++++ docs/creator/creator.md | 3 ++- docs/developer/typescript/typescript.md | 3 ++- .../01_gettingStarted/01_quickstart.md | 8 ++++++++ .../01_gettingStarted/02_hello/_category_.yml | 1 + .../01_gettingStarted/02_hello/index.md | 9 +++++++++ .../01_gettingStarted/_category_.yml | 2 +- .../visualscript/01_gettingStarted/index.md | 6 ------ .../{01_gettingStarted => 02_basics}/01_file.md | 0 .../02_file2.md | 0 .../02_basics/70_project/_category_.yml | 1 + .../visualscript/02_basics/70_project/index.md | 13 +++++++++++++ .../visualscript/02_basics}/_category_.yml | 0 docs/developer/visualscript/02_basics/index.md | 17 +++++++++++++++++ .../visualscript/02_topic1/_category_.yml | 1 - docs/developer/visualscript/02_topic1/index.md | 6 ------ .../03_beyondBasics}/_category_.yml | 0 .../visualscript/03_beyondBasics}/index.md | 0 .../developer/visualscript/03_topic2/01_file.md | 6 ------ .../visualscript/03_topic2/02_file2.md | 6 ------ .../visualscript/03_topic2/_category_.yml | 1 - docs/developer/visualscript/03_topic2/index.md | 6 ------ .../{02_topic1 => 60_mastery}/01_file.md | 0 .../{02_topic1 => 60_mastery}/02_file2.md | 0 .../visualscript/60_mastery/_category_.yml | 1 + docs/developer/visualscript/60_mastery/index.md | 15 +++++++++++++++ docs/developer/visualscript/visualscript.md | 4 +++- 44 files changed, 142 insertions(+), 42 deletions(-) create mode 100644 docs/creator/01_gettingStarted/01_quickstart.md create mode 100644 docs/creator/01_gettingStarted/02_hello/_category_.yml create mode 100644 docs/creator/01_gettingStarted/02_hello/index.md rename docs/creator/{01_gettingStarted => 02_basics}/01_file.md (100%) rename docs/creator/{01_gettingStarted => 02_basics}/02_file2.md (100%) create mode 100644 docs/creator/02_basics/70_project/_category_.yml create mode 100644 docs/creator/02_basics/70_project/index.md create mode 100644 docs/creator/02_basics/_category_.yml create mode 100644 docs/creator/02_basics/index.md rename docs/creator/{02_topic1 => 03_beyondBasics}/01_file.md (100%) rename docs/creator/{02_topic1 => 03_beyondBasics}/02_file2.md (100%) create mode 100644 docs/creator/03_beyondBasics/_category_.yml rename docs/creator/{02_topic1 => 03_beyondBasics}/index.md (97%) rename docs/creator/{03_topic2 => 60_mastery}/01_file.md (100%) rename docs/creator/{03_topic2 => 60_mastery}/02_file2.md (100%) create mode 100644 docs/creator/60_mastery/_category_.yml create mode 100644 docs/creator/60_mastery/index.md create mode 100644 docs/developer/visualscript/01_gettingStarted/01_quickstart.md create mode 100644 docs/developer/visualscript/01_gettingStarted/02_hello/_category_.yml create mode 100644 docs/developer/visualscript/01_gettingStarted/02_hello/index.md rename docs/developer/visualscript/{01_gettingStarted => 02_basics}/01_file.md (100%) rename docs/developer/visualscript/{01_gettingStarted => 02_basics}/02_file2.md (100%) create mode 100644 docs/developer/visualscript/02_basics/70_project/_category_.yml create mode 100644 docs/developer/visualscript/02_basics/70_project/index.md rename docs/{creator/02_topic1 => developer/visualscript/02_basics}/_category_.yml (100%) create mode 100644 docs/developer/visualscript/02_basics/index.md delete mode 100644 docs/developer/visualscript/02_topic1/_category_.yml delete mode 100644 docs/developer/visualscript/02_topic1/index.md rename docs/{creator/03_topic2 => developer/visualscript/03_beyondBasics}/_category_.yml (100%) rename docs/{creator/03_topic2 => developer/visualscript/03_beyondBasics}/index.md (100%) delete mode 100644 docs/developer/visualscript/03_topic2/01_file.md delete mode 100644 docs/developer/visualscript/03_topic2/02_file2.md delete mode 100644 docs/developer/visualscript/03_topic2/_category_.yml delete mode 100644 docs/developer/visualscript/03_topic2/index.md rename docs/developer/visualscript/{02_topic1 => 60_mastery}/01_file.md (100%) rename docs/developer/visualscript/{02_topic1 => 60_mastery}/02_file2.md (100%) create mode 100644 docs/developer/visualscript/60_mastery/_category_.yml create mode 100644 docs/developer/visualscript/60_mastery/index.md diff --git a/docs/creator/01_gettingStarted/01_quickstart.md b/docs/creator/01_gettingStarted/01_quickstart.md new file mode 100644 index 000000000000..b7b45bd8f554 --- /dev/null +++ b/docs/creator/01_gettingStarted/01_quickstart.md @@ -0,0 +1,8 @@ +--- +draft: true +--- + +# QuickStart + diff --git a/docs/creator/01_gettingStarted/02_hello/_category_.yml b/docs/creator/01_gettingStarted/02_hello/_category_.yml new file mode 100644 index 000000000000..e34d8cd3b323 --- /dev/null +++ b/docs/creator/01_gettingStarted/02_hello/_category_.yml @@ -0,0 +1 @@ +position: 02 diff --git a/docs/creator/01_gettingStarted/02_hello/index.md b/docs/creator/01_gettingStarted/02_hello/index.md new file mode 100644 index 000000000000..cc89fb1f6dc9 --- /dev/null +++ b/docs/creator/01_gettingStarted/02_hello/index.md @@ -0,0 +1,9 @@ +--- +draft: true +title: Hello Tree +--- + +# Hello World + diff --git a/docs/creator/01_gettingStarted/index.md b/docs/creator/01_gettingStarted/index.md index 2e58a8a9bf7a..684fd7197013 100644 --- a/docs/creator/01_gettingStarted/index.md +++ b/docs/creator/01_gettingStarted/index.md @@ -4,9 +4,5 @@ draft: true # Getting Started -_This page will contain a guide on how to get started creating content in Ethereal Engine._ -_In the meantime, please refer to the [Manual](/manual) section for more information._ diff --git a/docs/creator/01_gettingStarted/01_file.md b/docs/creator/02_basics/01_file.md similarity index 100% rename from docs/creator/01_gettingStarted/01_file.md rename to docs/creator/02_basics/01_file.md diff --git a/docs/creator/01_gettingStarted/02_file2.md b/docs/creator/02_basics/02_file2.md similarity index 100% rename from docs/creator/01_gettingStarted/02_file2.md rename to docs/creator/02_basics/02_file2.md diff --git a/docs/creator/02_basics/70_project/_category_.yml b/docs/creator/02_basics/70_project/_category_.yml new file mode 100644 index 000000000000..1d39e066281c --- /dev/null +++ b/docs/creator/02_basics/70_project/_category_.yml @@ -0,0 +1 @@ +position: 70 diff --git a/docs/creator/02_basics/70_project/index.md b/docs/creator/02_basics/70_project/index.md new file mode 100644 index 000000000000..4be107ed2f8a --- /dev/null +++ b/docs/creator/02_basics/70_project/index.md @@ -0,0 +1,13 @@ +--- +draft: true +--- + +# Hero Project + diff --git a/docs/creator/02_basics/_category_.yml b/docs/creator/02_basics/_category_.yml new file mode 100644 index 000000000000..e34d8cd3b323 --- /dev/null +++ b/docs/creator/02_basics/_category_.yml @@ -0,0 +1 @@ +position: 02 diff --git a/docs/creator/02_basics/index.md b/docs/creator/02_basics/index.md new file mode 100644 index 000000000000..b18069d54c0b --- /dev/null +++ b/docs/creator/02_basics/index.md @@ -0,0 +1,17 @@ +--- +draft: true +sidebar_label: Ethereal Engine Basics +--- + +import DocCardList from '@theme/DocCardList'; + +# Ethereal Engine Basics +This guide is a continuation of the [Hello World Tutorial](../gettingStarted/hello). +In this guide you will learn how to start expanding your knowledge of the engine beyond the Quickstart introductory guide. + + + diff --git a/docs/creator/02_topic1/01_file.md b/docs/creator/03_beyondBasics/01_file.md similarity index 100% rename from docs/creator/02_topic1/01_file.md rename to docs/creator/03_beyondBasics/01_file.md diff --git a/docs/creator/02_topic1/02_file2.md b/docs/creator/03_beyondBasics/02_file2.md similarity index 100% rename from docs/creator/02_topic1/02_file2.md rename to docs/creator/03_beyondBasics/02_file2.md diff --git a/docs/creator/03_beyondBasics/_category_.yml b/docs/creator/03_beyondBasics/_category_.yml new file mode 100644 index 000000000000..25aa7709d1ec --- /dev/null +++ b/docs/creator/03_beyondBasics/_category_.yml @@ -0,0 +1 @@ +position: 03 diff --git a/docs/creator/02_topic1/index.md b/docs/creator/03_beyondBasics/index.md similarity index 97% rename from docs/creator/02_topic1/index.md rename to docs/creator/03_beyondBasics/index.md index f8149c7c7c25..69b36b98d24e 100644 --- a/docs/creator/02_topic1/index.md +++ b/docs/creator/03_beyondBasics/index.md @@ -2,5 +2,5 @@ draft: true --- -# Topic 1 +# Beyond the Basics Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. Nisi anim cupidatat excepteur officia. Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. Nostrud officia pariatur ut officia. Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. diff --git a/docs/creator/03_topic2/01_file.md b/docs/creator/60_mastery/01_file.md similarity index 100% rename from docs/creator/03_topic2/01_file.md rename to docs/creator/60_mastery/01_file.md diff --git a/docs/creator/03_topic2/02_file2.md b/docs/creator/60_mastery/02_file2.md similarity index 100% rename from docs/creator/03_topic2/02_file2.md rename to docs/creator/60_mastery/02_file2.md diff --git a/docs/creator/60_mastery/_category_.yml b/docs/creator/60_mastery/_category_.yml new file mode 100644 index 000000000000..0c02fd033a91 --- /dev/null +++ b/docs/creator/60_mastery/_category_.yml @@ -0,0 +1 @@ +position: 60 diff --git a/docs/creator/60_mastery/index.md b/docs/creator/60_mastery/index.md new file mode 100644 index 000000000000..959905df3a85 --- /dev/null +++ b/docs/creator/60_mastery/index.md @@ -0,0 +1,15 @@ +--- +draft: true +--- + +import DocCardList from '@theme/DocCardList'; + +# Mastery Toolkit + + + diff --git a/docs/creator/creator.md b/docs/creator/creator.md index 0f23bfe258ec..85706a232a22 100644 --- a/docs/creator/creator.md +++ b/docs/creator/creator.md @@ -1,5 +1,6 @@ --- sidebar_position: 00 +title: Content Creator --- -# Become a Creator +# Become a Content Creator diff --git a/docs/developer/typescript/typescript.md b/docs/developer/typescript/typescript.md index ce702b4eda45..9367b0e17144 100644 --- a/docs/developer/typescript/typescript.md +++ b/docs/developer/typescript/typescript.md @@ -1,7 +1,8 @@ --- sidebar_position: 00 +title: Typescript Developer --- -# Become a Developer +# Become a Typescript Developer Here you will learn everything that there is to know about programming with Typescript + Ethereal Engine. diff --git a/docs/developer/visualscript/01_gettingStarted/02_hello/_category_.yml b/docs/developer/visualscript/01_gettingStarted/02_hello/_category_.yml new file mode 100644 index 000000000000..e34d8cd3b323 --- /dev/null +++ b/docs/developer/visualscript/01_gettingStarted/02_hello/_category_.yml @@ -0,0 +1 @@ +position: 02 diff --git a/docs/developer/visualscript/01_gettingStarted/02_hello/index.md b/docs/developer/visualscript/01_gettingStarted/02_hello/index.md new file mode 100644 index 000000000000..43d9414de152 --- /dev/null +++ b/docs/developer/visualscript/01_gettingStarted/02_hello/index.md @@ -0,0 +1,9 @@ +--- +draft: true +title: Hello Visualscript +--- + +# Hello World + diff --git a/docs/developer/visualscript/01_gettingStarted/_category_.yml b/docs/developer/visualscript/01_gettingStarted/_category_.yml index 873ad3e9da76..d6b968359e12 100644 --- a/docs/developer/visualscript/01_gettingStarted/_category_.yml +++ b/docs/developer/visualscript/01_gettingStarted/_category_.yml @@ -1 +1 @@ -position: 1 \ No newline at end of file +position: 01 diff --git a/docs/developer/visualscript/01_gettingStarted/index.md b/docs/developer/visualscript/01_gettingStarted/index.md index 1371da1b1c2a..f240c9b71a3a 100644 --- a/docs/developer/visualscript/01_gettingStarted/index.md +++ b/docs/developer/visualscript/01_gettingStarted/index.md @@ -4,12 +4,6 @@ title: Getting Started # Getting Started with VisualScript - _This guide will teach you how to get started programming with Ethereal Engine and VisualScript._ _Visit the [VisualScript: Introduction](/developer/visualscript) page for an overview of what VisualScript is._ diff --git a/docs/developer/visualscript/01_gettingStarted/01_file.md b/docs/developer/visualscript/02_basics/01_file.md similarity index 100% rename from docs/developer/visualscript/01_gettingStarted/01_file.md rename to docs/developer/visualscript/02_basics/01_file.md diff --git a/docs/developer/visualscript/01_gettingStarted/02_file2.md b/docs/developer/visualscript/02_basics/02_file2.md similarity index 100% rename from docs/developer/visualscript/01_gettingStarted/02_file2.md rename to docs/developer/visualscript/02_basics/02_file2.md diff --git a/docs/developer/visualscript/02_basics/70_project/_category_.yml b/docs/developer/visualscript/02_basics/70_project/_category_.yml new file mode 100644 index 000000000000..1d39e066281c --- /dev/null +++ b/docs/developer/visualscript/02_basics/70_project/_category_.yml @@ -0,0 +1 @@ +position: 70 diff --git a/docs/developer/visualscript/02_basics/70_project/index.md b/docs/developer/visualscript/02_basics/70_project/index.md new file mode 100644 index 000000000000..4be107ed2f8a --- /dev/null +++ b/docs/developer/visualscript/02_basics/70_project/index.md @@ -0,0 +1,13 @@ +--- +draft: true +--- + +# Hero Project + diff --git a/docs/creator/02_topic1/_category_.yml b/docs/developer/visualscript/02_basics/_category_.yml similarity index 100% rename from docs/creator/02_topic1/_category_.yml rename to docs/developer/visualscript/02_basics/_category_.yml diff --git a/docs/developer/visualscript/02_basics/index.md b/docs/developer/visualscript/02_basics/index.md new file mode 100644 index 000000000000..b18069d54c0b --- /dev/null +++ b/docs/developer/visualscript/02_basics/index.md @@ -0,0 +1,17 @@ +--- +draft: true +sidebar_label: Ethereal Engine Basics +--- + +import DocCardList from '@theme/DocCardList'; + +# Ethereal Engine Basics +This guide is a continuation of the [Hello World Tutorial](../gettingStarted/hello). +In this guide you will learn how to start expanding your knowledge of the engine beyond the Quickstart introductory guide. + + + diff --git a/docs/developer/visualscript/02_topic1/_category_.yml b/docs/developer/visualscript/02_topic1/_category_.yml deleted file mode 100644 index edbd9a5181e4..000000000000 --- a/docs/developer/visualscript/02_topic1/_category_.yml +++ /dev/null @@ -1 +0,0 @@ -position: 2 \ No newline at end of file diff --git a/docs/developer/visualscript/02_topic1/index.md b/docs/developer/visualscript/02_topic1/index.md deleted file mode 100644 index f8149c7c7c25..000000000000 --- a/docs/developer/visualscript/02_topic1/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -draft: true ---- - -# Topic 1 -Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. Nisi anim cupidatat excepteur officia. Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. Nostrud officia pariatur ut officia. Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. diff --git a/docs/creator/03_topic2/_category_.yml b/docs/developer/visualscript/03_beyondBasics/_category_.yml similarity index 100% rename from docs/creator/03_topic2/_category_.yml rename to docs/developer/visualscript/03_beyondBasics/_category_.yml diff --git a/docs/creator/03_topic2/index.md b/docs/developer/visualscript/03_beyondBasics/index.md similarity index 100% rename from docs/creator/03_topic2/index.md rename to docs/developer/visualscript/03_beyondBasics/index.md diff --git a/docs/developer/visualscript/03_topic2/01_file.md b/docs/developer/visualscript/03_topic2/01_file.md deleted file mode 100644 index 61c704402677..000000000000 --- a/docs/developer/visualscript/03_topic2/01_file.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -draft: true ---- - -# Topic -Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. Nisi anim cupidatat excepteur officia. Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. Nostrud officia pariatur ut officia. Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. diff --git a/docs/developer/visualscript/03_topic2/02_file2.md b/docs/developer/visualscript/03_topic2/02_file2.md deleted file mode 100644 index 61c704402677..000000000000 --- a/docs/developer/visualscript/03_topic2/02_file2.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -draft: true ---- - -# Topic -Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. Nisi anim cupidatat excepteur officia. Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. Nostrud officia pariatur ut officia. Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. diff --git a/docs/developer/visualscript/03_topic2/_category_.yml b/docs/developer/visualscript/03_topic2/_category_.yml deleted file mode 100644 index 71b6ec9c2427..000000000000 --- a/docs/developer/visualscript/03_topic2/_category_.yml +++ /dev/null @@ -1 +0,0 @@ -position: 3 \ No newline at end of file diff --git a/docs/developer/visualscript/03_topic2/index.md b/docs/developer/visualscript/03_topic2/index.md deleted file mode 100644 index 4832c949df99..000000000000 --- a/docs/developer/visualscript/03_topic2/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -draft: true ---- - -# Topic 2 -Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. Nisi anim cupidatat excepteur officia. Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. Nostrud officia pariatur ut officia. Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. diff --git a/docs/developer/visualscript/02_topic1/01_file.md b/docs/developer/visualscript/60_mastery/01_file.md similarity index 100% rename from docs/developer/visualscript/02_topic1/01_file.md rename to docs/developer/visualscript/60_mastery/01_file.md diff --git a/docs/developer/visualscript/02_topic1/02_file2.md b/docs/developer/visualscript/60_mastery/02_file2.md similarity index 100% rename from docs/developer/visualscript/02_topic1/02_file2.md rename to docs/developer/visualscript/60_mastery/02_file2.md diff --git a/docs/developer/visualscript/60_mastery/_category_.yml b/docs/developer/visualscript/60_mastery/_category_.yml new file mode 100644 index 000000000000..0c02fd033a91 --- /dev/null +++ b/docs/developer/visualscript/60_mastery/_category_.yml @@ -0,0 +1 @@ +position: 60 diff --git a/docs/developer/visualscript/60_mastery/index.md b/docs/developer/visualscript/60_mastery/index.md new file mode 100644 index 000000000000..959905df3a85 --- /dev/null +++ b/docs/developer/visualscript/60_mastery/index.md @@ -0,0 +1,15 @@ +--- +draft: true +--- + +import DocCardList from '@theme/DocCardList'; + +# Mastery Toolkit + + + diff --git a/docs/developer/visualscript/visualscript.md b/docs/developer/visualscript/visualscript.md index 9a7262479231..98e2ac5e60b7 100644 --- a/docs/developer/visualscript/visualscript.md +++ b/docs/developer/visualscript/visualscript.md @@ -1,7 +1,9 @@ --- sidebar_position: 00 +title: Visualscript Developer --- -# Become a Developer + +# Become a Visualscript Developer In this section you will learn everything that there is to know about programming with Visualscript + Ethereal Engine. From 0e95d43c746752af97d32f7ad93c7dfbdad6e25c Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 26 Mar 2024 13:36:53 +0100 Subject: [PATCH 02/33] new: Add Contribute+Community sections as Partials to all Microsites --- docs/_partials/community/assets.md | 4 ++ docs/_partials/community/channels.md | 15 +++++++ docs/_partials/community/intro.md | 3 ++ docs/_partials/community/tutorials.md | 4 ++ docs/_partials/contributing/develop.md | 2 + docs/_partials/contributing/documentation.md | 7 ++++ docs/_partials/contributing/donate.md | 3 ++ docs/_partials/contributing/host.md | 5 +++ docs/_partials/contributing/intro.md | 3 ++ docs/_partials/contributing/participate.md | 3 ++ docs/_partials/contributing/promote.md | 2 + docs/_partials/contributing/test.md | 4 ++ docs/_partials/contributing/translate.md | 3 ++ .../01_unity_bridge.md | 0 .../02_unreal_bridge.md | 0 .../_category_.yml | 0 docs/creator/98_contribute/_category_.yml | 1 + docs/creator/98_contribute/index.md | 34 ++++++++++++++++ docs/creator/99_community/_category_.yml | 1 + docs/creator/99_community/index.md | 28 +++++++++++++ .../typescript/98_contributing/_category_.yml | 1 + .../typescript/98_contributing/index.md | 39 +++++++++++++++++++ .../typescript/99_community/_category_.yml | 1 + .../typescript/99_community/index.md | 28 +++++++++++++ .../98_contributing/_category_.yml | 1 + .../visualscript/98_contributing/index.md | 34 ++++++++++++++++ .../visualscript/99_community/_category_.yml | 1 + .../visualscript/99_community/index.md | 28 +++++++++++++ 28 files changed, 255 insertions(+) create mode 100644 docs/_partials/community/assets.md create mode 100644 docs/_partials/community/channels.md create mode 100644 docs/_partials/community/intro.md create mode 100644 docs/_partials/community/tutorials.md create mode 100644 docs/_partials/contributing/develop.md create mode 100644 docs/_partials/contributing/documentation.md create mode 100644 docs/_partials/contributing/donate.md create mode 100644 docs/_partials/contributing/host.md create mode 100644 docs/_partials/contributing/intro.md create mode 100644 docs/_partials/contributing/participate.md create mode 100644 docs/_partials/contributing/promote.md create mode 100644 docs/_partials/contributing/test.md create mode 100644 docs/_partials/contributing/translate.md rename docs/creator/{98_tutorials => 96_tutorials}/01_unity_bridge.md (100%) rename docs/creator/{98_tutorials => 96_tutorials}/02_unreal_bridge.md (100%) rename docs/creator/{98_tutorials => 96_tutorials}/_category_.yml (100%) create mode 100644 docs/creator/98_contribute/_category_.yml create mode 100644 docs/creator/98_contribute/index.md create mode 100644 docs/creator/99_community/_category_.yml create mode 100644 docs/creator/99_community/index.md create mode 100644 docs/developer/typescript/98_contributing/_category_.yml create mode 100644 docs/developer/typescript/98_contributing/index.md create mode 100644 docs/developer/typescript/99_community/_category_.yml create mode 100644 docs/developer/typescript/99_community/index.md create mode 100644 docs/developer/visualscript/98_contributing/_category_.yml create mode 100644 docs/developer/visualscript/98_contributing/index.md create mode 100644 docs/developer/visualscript/99_community/_category_.yml create mode 100644 docs/developer/visualscript/99_community/index.md diff --git a/docs/_partials/community/assets.md b/docs/_partials/community/assets.md new file mode 100644 index 000000000000..58f74c61fc4a --- /dev/null +++ b/docs/_partials/community/assets.md @@ -0,0 +1,4 @@ + diff --git a/docs/_partials/community/channels.md b/docs/_partials/community/channels.md new file mode 100644 index 000000000000..65cc2f56badf --- /dev/null +++ b/docs/_partials/community/channels.md @@ -0,0 +1,15 @@ + + +You can join Ethereal Engine's community on: +- [Twitter](https://twitter.com/xr_engine) +- [Facebook](https://www.facebook.com/xrengine/) +- [Discord](https://discord.gg/xrf) + +Feel free to ask any questions that may come up. +We are here to help! + diff --git a/docs/_partials/community/intro.md b/docs/_partials/community/intro.md new file mode 100644 index 000000000000..10ff53e179b3 --- /dev/null +++ b/docs/_partials/community/intro.md @@ -0,0 +1,3 @@ + diff --git a/docs/_partials/community/tutorials.md b/docs/_partials/community/tutorials.md new file mode 100644 index 000000000000..f8e9f5a26208 --- /dev/null +++ b/docs/_partials/community/tutorials.md @@ -0,0 +1,4 @@ + diff --git a/docs/_partials/contributing/develop.md b/docs/_partials/contributing/develop.md new file mode 100644 index 000000000000..28d8a4e3096a --- /dev/null +++ b/docs/_partials/contributing/develop.md @@ -0,0 +1,2 @@ +Ethereal Engine is an open-source project, based on the [CPAL](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE) license. +You can find the source code of the engine on Ethereal Engine's [GitHub](https://github.com/EtherealEngine/etherealengine) repository, and some guidelines on how to contribute to its codebase in the [Contributing](https://github.com/EtherealEngine/etherealengine#contributing) section of the repository's readme. diff --git a/docs/_partials/contributing/documentation.md b/docs/_partials/contributing/documentation.md new file mode 100644 index 000000000000..315890270f68 --- /dev/null +++ b/docs/_partials/contributing/documentation.md @@ -0,0 +1,7 @@ +Documentation tasks are a great way to get started if you are new to the engine and/or development in general. + +If you are comfortable with code, the engine uses `JSDoc` and `TypeDoc` for generating its [API documentation](https://etherealengine.github.io/etherealengine-docs/typedoc), which is generated form the source code of the main Ethereal Engine's [source code repository](https://github.com/EtherealEngine/etherealengine). + +For an easier task, the documentation website you are reading right now is maintained from its own [GitHub repository](https://github.com/EtherealEngine/etherealengine-docs). Find something that you think could be improved in this website, and either open an issue or send a PR with your proposed changes. + +Get started by reading the [Get Involved: Documentation Guidelines](/manual/contributing/documentation). diff --git a/docs/_partials/contributing/donate.md b/docs/_partials/contributing/donate.md new file mode 100644 index 000000000000..10ff53e179b3 --- /dev/null +++ b/docs/_partials/contributing/donate.md @@ -0,0 +1,3 @@ + diff --git a/docs/_partials/contributing/host.md b/docs/_partials/contributing/host.md new file mode 100644 index 000000000000..d3b98e7cc04b --- /dev/null +++ b/docs/_partials/contributing/host.md @@ -0,0 +1,5 @@ +Ethereal Engine is a platform aimed at helping you achieve your goals. +And nothing showcases a great tool better than some great projects made with it! + +Complete the **Getting Started** tutorials, learn to use the engine with the [Ethereal Engine Manual](/manual), create a cool project that you love and then share it with the world. + diff --git a/docs/_partials/contributing/intro.md b/docs/_partials/contributing/intro.md new file mode 100644 index 000000000000..10ff53e179b3 --- /dev/null +++ b/docs/_partials/contributing/intro.md @@ -0,0 +1,3 @@ + diff --git a/docs/_partials/contributing/participate.md b/docs/_partials/contributing/participate.md new file mode 100644 index 000000000000..d25264ad41a7 --- /dev/null +++ b/docs/_partials/contributing/participate.md @@ -0,0 +1,3 @@ +The easiest way to get involved is to participate in Ethereal Engine's community. +Join us on your favorite [community channel](/manual/community) and become a part of the conversation. +Ask any questions that you may have and/or help other users with their questions. diff --git a/docs/_partials/contributing/promote.md b/docs/_partials/contributing/promote.md new file mode 100644 index 000000000000..4df520f31c56 --- /dev/null +++ b/docs/_partials/contributing/promote.md @@ -0,0 +1,2 @@ +Talk about the engine with people you know. Let them know about those cool projects that you have created, or those locations that you like the most. Being a user and overall advocate of Ethereal Engine is a great way to help growing the community. + diff --git a/docs/_partials/contributing/test.md b/docs/_partials/contributing/test.md new file mode 100644 index 000000000000..a7552794394c --- /dev/null +++ b/docs/_partials/contributing/test.md @@ -0,0 +1,4 @@ +Our team is constantly on the lookout for potential issues during development, and we have a really high standard for Code Reviewing and QA _(Quality Assurance)_. But sometimes bugs can go unnoticed and sneak into release versions of the codebase. +Because of this, another great way to contribute is by reporting errors, problems or issues that may show up in different versions of Ethereal Engine. + +Search for the issue in our [Issues List](https://github.com/EtherealEngine/etherealengine/issues), and open a new one if you think that what you found has not been reported yet. diff --git a/docs/_partials/contributing/translate.md b/docs/_partials/contributing/translate.md new file mode 100644 index 000000000000..10ff53e179b3 --- /dev/null +++ b/docs/_partials/contributing/translate.md @@ -0,0 +1,3 @@ + diff --git a/docs/creator/98_tutorials/01_unity_bridge.md b/docs/creator/96_tutorials/01_unity_bridge.md similarity index 100% rename from docs/creator/98_tutorials/01_unity_bridge.md rename to docs/creator/96_tutorials/01_unity_bridge.md diff --git a/docs/creator/98_tutorials/02_unreal_bridge.md b/docs/creator/96_tutorials/02_unreal_bridge.md similarity index 100% rename from docs/creator/98_tutorials/02_unreal_bridge.md rename to docs/creator/96_tutorials/02_unreal_bridge.md diff --git a/docs/creator/98_tutorials/_category_.yml b/docs/creator/96_tutorials/_category_.yml similarity index 100% rename from docs/creator/98_tutorials/_category_.yml rename to docs/creator/96_tutorials/_category_.yml diff --git a/docs/creator/98_contribute/_category_.yml b/docs/creator/98_contribute/_category_.yml new file mode 100644 index 000000000000..e1a5987eda55 --- /dev/null +++ b/docs/creator/98_contribute/_category_.yml @@ -0,0 +1 @@ +position: 98 diff --git a/docs/creator/98_contribute/index.md b/docs/creator/98_contribute/index.md new file mode 100644 index 000000000000..7e15119ff9e4 --- /dev/null +++ b/docs/creator/98_contribute/index.md @@ -0,0 +1,34 @@ +import Intro from '@site/docs/_partials/contributing/intro.md' +import Participate from '@site/docs/_partials/contributing/participate.md' +import Host from '@site/docs/_partials/contributing/host.md' +import Promote from '@site/docs/_partials/contributing/promote.md' +import Test from '@site/docs/_partials/contributing/test.md' +import Documentation from '@site/docs/_partials/contributing/documentation.md' +import Translate from '@site/docs/_partials/contributing/translate.md' +import Donate from '@site/docs/_partials/contributing/donate.md' + +# Get Involved + + +## Participate in the community + + +## Create and Host your own worlds + + +## Promote Ethereal Engine + + +## Testing and reporting issues + + +## Contribute to Ethereal Engine's documentation + + +## Translate Ethereal Engine + + + diff --git a/docs/creator/99_community/_category_.yml b/docs/creator/99_community/_category_.yml new file mode 100644 index 000000000000..43efea911701 --- /dev/null +++ b/docs/creator/99_community/_category_.yml @@ -0,0 +1 @@ +position: 99 diff --git a/docs/creator/99_community/index.md b/docs/creator/99_community/index.md new file mode 100644 index 000000000000..677203ea1b5e --- /dev/null +++ b/docs/creator/99_community/index.md @@ -0,0 +1,28 @@ +import CommunityIntro from '@site/docs/_partials/community/intro.md' +import CommunityChannels from '@site/docs/_partials/community/channels.md' +import CommunityAssets from '@site/docs/_partials/community/assets.md' +import CommunityTutorials from '@site/docs/_partials/community/tutorials.md' + +# Community + + + + + + + + + + + + + + + + + diff --git a/docs/developer/typescript/98_contributing/_category_.yml b/docs/developer/typescript/98_contributing/_category_.yml new file mode 100644 index 000000000000..e1a5987eda55 --- /dev/null +++ b/docs/developer/typescript/98_contributing/_category_.yml @@ -0,0 +1 @@ +position: 98 diff --git a/docs/developer/typescript/98_contributing/index.md b/docs/developer/typescript/98_contributing/index.md new file mode 100644 index 000000000000..fdfe69c719ba --- /dev/null +++ b/docs/developer/typescript/98_contributing/index.md @@ -0,0 +1,39 @@ +import Intro from '@site/docs/_partials/contributing/intro.md' +import Participate from '@site/docs/_partials/contributing/participate.md' +import Host from '@site/docs/_partials/contributing/host.md' +import Promote from '@site/docs/_partials/contributing/promote.md' +import Develop from '@site/docs/_partials/contributing/develop.md' +import Test from '@site/docs/_partials/contributing/test.md' +import Documentation from '@site/docs/_partials/contributing/documentation.md' +import Translate from '@site/docs/_partials/contributing/translate.md' +import Donate from '@site/docs/_partials/contributing/donate.md' + +# Get Involved + + +## Participate in the community + + +## Create and Host your own worlds + + +## Promote Ethereal Engine + + +## Contribute to Ethereal Engine's development + + +## Testing and reporting issues + + +## Contribute to Ethereal Engine's documentation + + +## Translate Ethereal Engine + + + + diff --git a/docs/developer/typescript/99_community/_category_.yml b/docs/developer/typescript/99_community/_category_.yml new file mode 100644 index 000000000000..43efea911701 --- /dev/null +++ b/docs/developer/typescript/99_community/_category_.yml @@ -0,0 +1 @@ +position: 99 diff --git a/docs/developer/typescript/99_community/index.md b/docs/developer/typescript/99_community/index.md new file mode 100644 index 000000000000..677203ea1b5e --- /dev/null +++ b/docs/developer/typescript/99_community/index.md @@ -0,0 +1,28 @@ +import CommunityIntro from '@site/docs/_partials/community/intro.md' +import CommunityChannels from '@site/docs/_partials/community/channels.md' +import CommunityAssets from '@site/docs/_partials/community/assets.md' +import CommunityTutorials from '@site/docs/_partials/community/tutorials.md' + +# Community + + + + + + + + + + + + + + + + + diff --git a/docs/developer/visualscript/98_contributing/_category_.yml b/docs/developer/visualscript/98_contributing/_category_.yml new file mode 100644 index 000000000000..e1a5987eda55 --- /dev/null +++ b/docs/developer/visualscript/98_contributing/_category_.yml @@ -0,0 +1 @@ +position: 98 diff --git a/docs/developer/visualscript/98_contributing/index.md b/docs/developer/visualscript/98_contributing/index.md new file mode 100644 index 000000000000..7e15119ff9e4 --- /dev/null +++ b/docs/developer/visualscript/98_contributing/index.md @@ -0,0 +1,34 @@ +import Intro from '@site/docs/_partials/contributing/intro.md' +import Participate from '@site/docs/_partials/contributing/participate.md' +import Host from '@site/docs/_partials/contributing/host.md' +import Promote from '@site/docs/_partials/contributing/promote.md' +import Test from '@site/docs/_partials/contributing/test.md' +import Documentation from '@site/docs/_partials/contributing/documentation.md' +import Translate from '@site/docs/_partials/contributing/translate.md' +import Donate from '@site/docs/_partials/contributing/donate.md' + +# Get Involved + + +## Participate in the community + + +## Create and Host your own worlds + + +## Promote Ethereal Engine + + +## Testing and reporting issues + + +## Contribute to Ethereal Engine's documentation + + +## Translate Ethereal Engine + + + diff --git a/docs/developer/visualscript/99_community/_category_.yml b/docs/developer/visualscript/99_community/_category_.yml new file mode 100644 index 000000000000..43efea911701 --- /dev/null +++ b/docs/developer/visualscript/99_community/_category_.yml @@ -0,0 +1 @@ +position: 99 diff --git a/docs/developer/visualscript/99_community/index.md b/docs/developer/visualscript/99_community/index.md new file mode 100644 index 000000000000..677203ea1b5e --- /dev/null +++ b/docs/developer/visualscript/99_community/index.md @@ -0,0 +1,28 @@ +import CommunityIntro from '@site/docs/_partials/community/intro.md' +import CommunityChannels from '@site/docs/_partials/community/channels.md' +import CommunityAssets from '@site/docs/_partials/community/assets.md' +import CommunityTutorials from '@site/docs/_partials/community/tutorials.md' + +# Community + + + + + + + + + + + + + + + + + From 2e7fb6dbbe76a0f480447c644b460b45f7b4a8da Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 26 Mar 2024 13:37:43 +0100 Subject: [PATCH 03/33] chg: Read manual/contributing and community content from partials --- docs/_partials/license.md | 7 ++++ docs/manual/97_license.md | 10 ++---- docs/manual/98_contributing/index.md | 48 +++++++++++++++------------- docs/manual/99_community/index.md | 33 ++++++------------- 4 files changed, 45 insertions(+), 53 deletions(-) create mode 100644 docs/_partials/license.md diff --git a/docs/_partials/license.md b/docs/_partials/license.md new file mode 100644 index 000000000000..e0a3ee15dc82 --- /dev/null +++ b/docs/_partials/license.md @@ -0,0 +1,7 @@ +Ethereal Engine is [open-source](https://github.com/EtherealEngine/etherealengine), under the terms and conditions of the [CPAL](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE) license. +Attribution is required if you wish to use Ethereal Engine under [CPAL](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE). +Please see the attribution guidelines in Ethereal Engine's [LICENSE](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE) file. + +Other licensing options are available, please contact us for more information. + +[CPAL](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE) - Copyright (c) 2021-2023 Ethereal Engine, formerly known as XREngine by XR Foundation diff --git a/docs/manual/97_license.md b/docs/manual/97_license.md index 2b8e1486e414..a0bacfefa530 100644 --- a/docs/manual/97_license.md +++ b/docs/manual/97_license.md @@ -1,8 +1,4 @@ -# License -Ethereal Engine is [open-source](https://github.com/EtherealEngine/etherealengine), under the terms and conditions of the [CPAL](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE) license. -Attribution is required if you wish to use Ethereal Engine under [CPAL](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE). -Please see the attribution guidelines in Ethereal Engine's [LICENSE](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE) file. - -Other licensing options are available, please contact us for more information. +import License from '@site/docs/_partials/license.md' -[CPAL](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE) - Copyright (c) 2021-2023 Ethereal Engine, formerly known as XREngine by XR Foundation +# License + diff --git a/docs/manual/98_contributing/index.md b/docs/manual/98_contributing/index.md index 7512340dc165..4d6c5996ec7e 100644 --- a/docs/manual/98_contributing/index.md +++ b/docs/manual/98_contributing/index.md @@ -1,48 +1,50 @@ +import Intro from '@site/docs/_partials/contributing/intro.md' +import Participate from '@site/docs/_partials/contributing/participate.md' +import Host from '@site/docs/_partials/contributing/host.md' +import Promote from '@site/docs/_partials/contributing/promote.md' +import Develop from '@site/docs/_partials/contributing/develop.md' +import Test from '@site/docs/_partials/contributing/test.md' +import Documentation from '@site/docs/_partials/contributing/documentation.md' +import Translate from '@site/docs/_partials/contributing/translate.md' +import Donate from '@site/docs/_partials/contributing/donate.md' + # Get Involved + ## Participate in the community -The easiest way to get involved is to participate in Ethereal Engine's community. -Join us on your favorite [community channel](/manual/community) and become a part of the conversation. -Ask any questions that you may have and/or help other users with their questions. + ## Create and Host your own worlds -Ethereal Engine is a platform aimed at helping you achieve your goals. -And nothing showcases a great tool better than some great projects made with it! - -Complete the **Getting Started** tutorials, learn to use the engine with the [Ethereal Engine Manual](/manual), create a cool project that you love and then share it with the world. - + ## Promote Ethereal Engine -Talk about the engine with people you know. Let them know about those cool projects that you have created, or those locations that you like the most. Being a user and overall advocate of Ethereal Engine is a great way to help growing the community. - + ## Contribute to Ethereal Engine's development -Ethereal Engine is an open-source project, based on the [CPAL](https://github.com/EtherealEngine/etherealengine/blob/dev/LICENSE) license. -You can find the source code of the engine on Ethereal Engine's [GitHub](https://github.com/EtherealEngine/etherealengine) repository, and some guidelines on how to contribute to its codebase in the [Contributing](https://github.com/EtherealEngine/etherealengine#contributing) section of the repository's readme. + ## Testing and reporting issues -Our team is constantly on the lookout for potential issues during development, and we have a really high standard for Code Reviewing and QA _(Quality Assurance)_. But sometimes bugs can go unnoticed and sneak into release versions of the codebase. -Because of this, another great way to contribute is by reporting errors, problems or issues that may show up in different versions of Ethereal Engine. - -Search for the issue in our [Issues List](https://github.com/EtherealEngine/etherealengine/issues), and open a new one if you think that what you found has not been reported yet. + ## Contribute to Ethereal Engine's documentation -Documentation tasks are a great way to get started if you are new to the engine and/or development in general. + -If you are comfortable with code, the engine uses `JSDoc` and `TypeDoc` for generating its [API documentation](https://etherealengine.github.io/etherealengine-docs/typedoc), which is generated form the source code of the main Ethereal Engine's [source code repository](https://github.com/EtherealEngine/etherealengine). +## Translate Ethereal Engine + -For an easier task, the documentation website you are reading right now is maintained from its own [GitHub repository](https://github.com/EtherealEngine/etherealengine-docs). Find something that you think could be improved in this website, and either open an issue or send a PR with your proposed changes. - -Get started by reading the [Get Involved: Documentation Guidelines](./documentation). + diff --git a/docs/manual/99_community/index.md b/docs/manual/99_community/index.md index 1552c5e517fb..677203ea1b5e 100644 --- a/docs/manual/99_community/index.md +++ b/docs/manual/99_community/index.md @@ -1,3 +1,8 @@ +import CommunityIntro from '@site/docs/_partials/community/intro.md' +import CommunityChannels from '@site/docs/_partials/community/channels.md' +import CommunityAssets from '@site/docs/_partials/community/assets.md' +import CommunityTutorials from '@site/docs/_partials/community/tutorials.md' + # Community -You can join Ethereal Engine's community on: -- [Twitter](https://twitter.com/xr_engine) -- [Facebook](https://www.facebook.com/xrengine/) -- [Discord](https://discord.gg/xrf) - -Feel free to ask any questions that may come up. -We are here to help! - + - + + + + - - - From 5d2599498ea3dc280d03b2aa49cc1ad5be6c0b59 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 26 Mar 2024 13:38:21 +0100 Subject: [PATCH 04/33] new: Concepts and Hosting partials sketch --- docs/_partials/concepts/creator/concept1.md | 1 + docs/_partials/concepts/general/concept1.md | 1 + docs/_partials/concepts/typescript/concept1.md | 1 + docs/_partials/concepts/visualscript/concept1.md | 1 + docs/_partials/host/topic1.md | 1 + 5 files changed, 5 insertions(+) create mode 100644 docs/_partials/concepts/creator/concept1.md create mode 100644 docs/_partials/concepts/general/concept1.md create mode 100644 docs/_partials/concepts/typescript/concept1.md create mode 100644 docs/_partials/concepts/visualscript/concept1.md create mode 100644 docs/_partials/host/topic1.md diff --git a/docs/_partials/concepts/creator/concept1.md b/docs/_partials/concepts/creator/concept1.md new file mode 100644 index 000000000000..3cf7ef4285b4 --- /dev/null +++ b/docs/_partials/concepts/creator/concept1.md @@ -0,0 +1 @@ +Concept1 diff --git a/docs/_partials/concepts/general/concept1.md b/docs/_partials/concepts/general/concept1.md new file mode 100644 index 000000000000..3cf7ef4285b4 --- /dev/null +++ b/docs/_partials/concepts/general/concept1.md @@ -0,0 +1 @@ +Concept1 diff --git a/docs/_partials/concepts/typescript/concept1.md b/docs/_partials/concepts/typescript/concept1.md new file mode 100644 index 000000000000..3cf7ef4285b4 --- /dev/null +++ b/docs/_partials/concepts/typescript/concept1.md @@ -0,0 +1 @@ +Concept1 diff --git a/docs/_partials/concepts/visualscript/concept1.md b/docs/_partials/concepts/visualscript/concept1.md new file mode 100644 index 000000000000..3cf7ef4285b4 --- /dev/null +++ b/docs/_partials/concepts/visualscript/concept1.md @@ -0,0 +1 @@ +Concept1 diff --git a/docs/_partials/host/topic1.md b/docs/_partials/host/topic1.md new file mode 100644 index 000000000000..ae7cec72dde4 --- /dev/null +++ b/docs/_partials/host/topic1.md @@ -0,0 +1 @@ +Topic1 From 9af3d845e396498d555dc597dc7c9871128b264b Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 26 Mar 2024 14:11:29 +0100 Subject: [PATCH 05/33] new: `Host your own World` section for the learning microsites --- docs/_partials/host/intro.md | 3 +++ docs/_partials/host/topic1.md | 1 - docs/creator/97_host/_category_.yml | 1 + docs/creator/97_host/index.md | 8 ++++++++ docs/developer/typescript/97_host/_category_.yml | 1 + docs/developer/typescript/97_host/index.md | 8 ++++++++ docs/developer/visualscript/97_host/_category_.yml | 1 + docs/developer/visualscript/97_host/index.md | 8 ++++++++ 8 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 docs/_partials/host/intro.md delete mode 100644 docs/_partials/host/topic1.md create mode 100644 docs/creator/97_host/_category_.yml create mode 100644 docs/creator/97_host/index.md create mode 100644 docs/developer/typescript/97_host/_category_.yml create mode 100644 docs/developer/typescript/97_host/index.md create mode 100644 docs/developer/visualscript/97_host/_category_.yml create mode 100644 docs/developer/visualscript/97_host/index.md diff --git a/docs/_partials/host/intro.md b/docs/_partials/host/intro.md new file mode 100644 index 000000000000..10ff53e179b3 --- /dev/null +++ b/docs/_partials/host/intro.md @@ -0,0 +1,3 @@ + diff --git a/docs/_partials/host/topic1.md b/docs/_partials/host/topic1.md deleted file mode 100644 index ae7cec72dde4..000000000000 --- a/docs/_partials/host/topic1.md +++ /dev/null @@ -1 +0,0 @@ -Topic1 diff --git a/docs/creator/97_host/_category_.yml b/docs/creator/97_host/_category_.yml new file mode 100644 index 000000000000..67e2ae30d4b3 --- /dev/null +++ b/docs/creator/97_host/_category_.yml @@ -0,0 +1 @@ +position: 97 diff --git a/docs/creator/97_host/index.md b/docs/creator/97_host/index.md new file mode 100644 index 000000000000..12d2bd772c15 --- /dev/null +++ b/docs/creator/97_host/index.md @@ -0,0 +1,8 @@ +--- +draft: true +--- +import Intro from '@site/docs/_partials/host/intro.md' + +# Host your own World + + diff --git a/docs/developer/typescript/97_host/_category_.yml b/docs/developer/typescript/97_host/_category_.yml new file mode 100644 index 000000000000..67e2ae30d4b3 --- /dev/null +++ b/docs/developer/typescript/97_host/_category_.yml @@ -0,0 +1 @@ +position: 97 diff --git a/docs/developer/typescript/97_host/index.md b/docs/developer/typescript/97_host/index.md new file mode 100644 index 000000000000..12d2bd772c15 --- /dev/null +++ b/docs/developer/typescript/97_host/index.md @@ -0,0 +1,8 @@ +--- +draft: true +--- +import Intro from '@site/docs/_partials/host/intro.md' + +# Host your own World + + diff --git a/docs/developer/visualscript/97_host/_category_.yml b/docs/developer/visualscript/97_host/_category_.yml new file mode 100644 index 000000000000..67e2ae30d4b3 --- /dev/null +++ b/docs/developer/visualscript/97_host/_category_.yml @@ -0,0 +1 @@ +position: 97 diff --git a/docs/developer/visualscript/97_host/index.md b/docs/developer/visualscript/97_host/index.md new file mode 100644 index 000000000000..12d2bd772c15 --- /dev/null +++ b/docs/developer/visualscript/97_host/index.md @@ -0,0 +1,8 @@ +--- +draft: true +--- +import Intro from '@site/docs/_partials/host/intro.md' + +# Host your own World + + From b14f96228ed69a824a04ddbec3ef15b6af6a6fd4 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Fri, 29 Mar 2024 17:18:12 +0100 Subject: [PATCH 06/33] new: Create the Roadmap introduction content (using _partials) --- docs/_partials/roadmap/indev.md | 16 ++++++++++++++++ docs/_partials/roadmap/intro.md | 9 +++++++++ docs/_partials/roadmap/order.md | 13 +++++++++++++ docs/_partials/roadmap/overview.md | 18 ++++++++++++++++++ docs/_partials/roadmap/tldr.md | 4 ++++ 5 files changed, 60 insertions(+) create mode 100644 docs/_partials/roadmap/indev.md create mode 100644 docs/_partials/roadmap/intro.md create mode 100644 docs/_partials/roadmap/order.md create mode 100644 docs/_partials/roadmap/overview.md create mode 100644 docs/_partials/roadmap/tldr.md diff --git a/docs/_partials/roadmap/indev.md b/docs/_partials/roadmap/indev.md new file mode 100644 index 000000000000..ad0e6755db54 --- /dev/null +++ b/docs/_partials/roadmap/indev.md @@ -0,0 +1,16 @@ +:::important +This website is currently **In Development**. + +There will be a point when you hit the end of the existing "tutorials road", and you will need to continue with your learning journey beyond the content that is already covered. +This roadmap is exactly the tool for that job. +::: + +:::note[disclaimer] +This is not a replacement for proper in-depth guides, examples, templates and other learning content. +It is a temporary solution to help you navigate the current shortcomings of this website while it is being built. +::: + +:::note[important note] +The content written in this page is not very thorough, but it should be very clear. +Please [send us your feedback](/manual/contributing) if you find anything that is unclear. +::: diff --git a/docs/_partials/roadmap/intro.md b/docs/_partials/roadmap/intro.md new file mode 100644 index 000000000000..1d0900cfd0fe --- /dev/null +++ b/docs/_partials/roadmap/intro.md @@ -0,0 +1,9 @@ +import TLDR from '@site/docs/_partials/roadmap/tldr.md' +import InDevDisclaimer from '@site/docs/_partials/roadmap/indev.md' +import Overview from '@site/docs/_partials/roadmap/overview.md' + + + + +## What are the Roadmaps + diff --git a/docs/_partials/roadmap/order.md b/docs/_partials/roadmap/order.md new file mode 100644 index 000000000000..c58248a895f7 --- /dev/null +++ b/docs/_partials/roadmap/order.md @@ -0,0 +1,13 @@ +:::warning +**Reading Order Matters**: +This list of concepts is layed out in the order that they should be learned. + +Most Concepts will build on knowledge acquired previously from other Concepts earlier in the roadmap. +If you get stuck understanding a concept, or how to use it, the next concepts in the list might be difficult to follow. +::: + +:::tip +That said, don't let reading order stop your progress. +Just make sure to come back and revisit Concepts earlier in the list if you get stuck somewhere further down the road. +::: + diff --git a/docs/_partials/roadmap/overview.md b/docs/_partials/roadmap/overview.md new file mode 100644 index 000000000000..cca7bb9af83b --- /dev/null +++ b/docs/_partials/roadmap/overview.md @@ -0,0 +1,18 @@ +Learning / reading content is much much faster than the amount of the time it takes to write it. + +Due to this website being In-Development, you will eventually find an "end of the road" type of situation. +There will be no more content written, but you won't have learned everything there is to know about Ethereal Engine yet. + +This Roadmap is meant to alleviate that problem as much as possible. +Even if you don't have a specific guide teaching you _how_ to do something... you might be able to figure it out on your own if you know exactly **what** you need to research about. +Knowing exactly **what you need to know** will get you _(at least)_ 50% of the way there. + +This Roadmap contains: +- A list of all concepts required to learn Etheral Engine for the Learning Path you chose +- A short definition of each concept +- Links to the Roadmaps of the other Learning Paths, so you can have a clearer mental model of Ethereal Engine as a whole + +:::note +The goal of these definitions is (also) to help you differentiate these concepts from other concepts that might be using the same (or very similar) words outside of the context of Ethereal Engine. +::: + diff --git a/docs/_partials/roadmap/tldr.md b/docs/_partials/roadmap/tldr.md new file mode 100644 index 000000000000..8d5c7464ed2b --- /dev/null +++ b/docs/_partials/roadmap/tldr.md @@ -0,0 +1,4 @@ +> *TL;DR:* If you get lost, but you have a roadmap, at least you will know _where_ you need to go. +> +> This Roadmap will help you know exactly **what you need to know** to learn Ethereal Engine. +> Armed with this Roadmap, you should be able to do your own research and figure out the Engine on your own. From c8a8f7bdddb851b26cecae879919c52dd45b9245 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Fri, 29 Mar 2024 17:19:08 +0100 Subject: [PATCH 07/33] new: Typescript Roadmap temporary mockup --- docs/_partials/concepts/typescript.md | 9 +++++++++ docs/_partials/concepts/typescript/concept1.md | 12 +++++++++++- .../typescript/90_roadmap/_category_.yml | 1 + docs/developer/typescript/90_roadmap/index.md | 16 ++++++++++++++++ 4 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/_partials/concepts/typescript.md create mode 100644 docs/developer/typescript/90_roadmap/_category_.yml create mode 100644 docs/developer/typescript/90_roadmap/index.md diff --git a/docs/_partials/concepts/typescript.md b/docs/_partials/concepts/typescript.md new file mode 100644 index 000000000000..87471365653f --- /dev/null +++ b/docs/_partials/concepts/typescript.md @@ -0,0 +1,9 @@ + +import Concept1 from '@site/docs/_partials/concepts/typescript/concept1.md' + + + + + + + diff --git a/docs/_partials/concepts/typescript/concept1.md b/docs/_partials/concepts/typescript/concept1.md index 3cf7ef4285b4..00048ac54575 100644 --- a/docs/_partials/concepts/typescript/concept1.md +++ b/docs/_partials/concepts/typescript/concept1.md @@ -1 +1,11 @@ -Concept1 +**Concept1**: + +Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. +Nisi anim cupidatat excepteur officia. +Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. +Nostrud officia pariatur ut officia. + +Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. +Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. +Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. +Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. diff --git a/docs/developer/typescript/90_roadmap/_category_.yml b/docs/developer/typescript/90_roadmap/_category_.yml new file mode 100644 index 000000000000..74a6c2ee411d --- /dev/null +++ b/docs/developer/typescript/90_roadmap/_category_.yml @@ -0,0 +1 @@ +position: 90 diff --git a/docs/developer/typescript/90_roadmap/index.md b/docs/developer/typescript/90_roadmap/index.md new file mode 100644 index 000000000000..d2180ebe7a1f --- /dev/null +++ b/docs/developer/typescript/90_roadmap/index.md @@ -0,0 +1,16 @@ +--- +title: "Learning Roadmap" +draft: true +--- + +import Introduction from '@site/docs/_partials/roadmap/intro.md' +import ReadingOrder from '@site/docs/_partials/roadmap/order.md' +import TypescriptConcepts from '@site/docs/_partials/concepts/typescript.md' + +# Typescript Learning Roadmap + + +## Concepts List + + + From 274592de01995de9521709b5d39fd8b3ffedd27c Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Fri, 29 Mar 2024 17:50:44 +0100 Subject: [PATCH 08/33] new: Visualscript Roadmap temporary mockup --- docs/_partials/concepts/visualscript.md | 9 +++++++++ docs/_partials/concepts/visualscript/concept1.md | 12 +++++++++++- .../visualscript/90_roadmap/_category_.yml | 1 + docs/developer/visualscript/90_roadmap/index.md | 16 ++++++++++++++++ 4 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 docs/_partials/concepts/visualscript.md create mode 100644 docs/developer/visualscript/90_roadmap/_category_.yml create mode 100644 docs/developer/visualscript/90_roadmap/index.md diff --git a/docs/_partials/concepts/visualscript.md b/docs/_partials/concepts/visualscript.md new file mode 100644 index 000000000000..323857667d3a --- /dev/null +++ b/docs/_partials/concepts/visualscript.md @@ -0,0 +1,9 @@ + +import Concept1 from '@site/docs/_partials/concepts/visualscript/concept1.md' + + + + + + + diff --git a/docs/_partials/concepts/visualscript/concept1.md b/docs/_partials/concepts/visualscript/concept1.md index 3cf7ef4285b4..00048ac54575 100644 --- a/docs/_partials/concepts/visualscript/concept1.md +++ b/docs/_partials/concepts/visualscript/concept1.md @@ -1 +1,11 @@ -Concept1 +**Concept1**: + +Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. +Nisi anim cupidatat excepteur officia. +Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. +Nostrud officia pariatur ut officia. + +Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. +Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. +Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. +Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. diff --git a/docs/developer/visualscript/90_roadmap/_category_.yml b/docs/developer/visualscript/90_roadmap/_category_.yml new file mode 100644 index 000000000000..74a6c2ee411d --- /dev/null +++ b/docs/developer/visualscript/90_roadmap/_category_.yml @@ -0,0 +1 @@ +position: 90 diff --git a/docs/developer/visualscript/90_roadmap/index.md b/docs/developer/visualscript/90_roadmap/index.md new file mode 100644 index 000000000000..7e680b855103 --- /dev/null +++ b/docs/developer/visualscript/90_roadmap/index.md @@ -0,0 +1,16 @@ +--- +title: "Learning Roadmap" +draft: true +--- + +import Introduction from '@site/docs/_partials/roadmap/intro.md' +import ReadingOrder from '@site/docs/_partials/roadmap/order.md' +import VisualscriptConcepts from '@site/docs/_partials/concepts/visualscript.md' + +# Visualcript Learning Roadmap + + +## Concepts List + + + From fd8fa1104aa5fc2962ac261781c59b6d66357347 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Fri, 29 Mar 2024 17:51:00 +0100 Subject: [PATCH 09/33] new: Creator Roadmap temporary mockup --- docs/_partials/concepts/creator.md | 9 +++++++++ docs/_partials/concepts/creator/concept1.md | 12 +++++++++++- docs/_partials/concepts/general/concept1.md | 12 +++++++++++- docs/creator/90_roadmap/_category_.yml | 1 + docs/creator/90_roadmap/index.md | 16 ++++++++++++++++ 5 files changed, 48 insertions(+), 2 deletions(-) create mode 100644 docs/_partials/concepts/creator.md create mode 100644 docs/creator/90_roadmap/_category_.yml create mode 100644 docs/creator/90_roadmap/index.md diff --git a/docs/_partials/concepts/creator.md b/docs/_partials/concepts/creator.md new file mode 100644 index 000000000000..5007707de851 --- /dev/null +++ b/docs/_partials/concepts/creator.md @@ -0,0 +1,9 @@ + +import Concept1 from '@site/docs/_partials/concepts/creator/concept1.md' + + + + + + + diff --git a/docs/_partials/concepts/creator/concept1.md b/docs/_partials/concepts/creator/concept1.md index 3cf7ef4285b4..00048ac54575 100644 --- a/docs/_partials/concepts/creator/concept1.md +++ b/docs/_partials/concepts/creator/concept1.md @@ -1 +1,11 @@ -Concept1 +**Concept1**: + +Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. +Nisi anim cupidatat excepteur officia. +Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. +Nostrud officia pariatur ut officia. + +Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. +Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. +Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. +Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. diff --git a/docs/_partials/concepts/general/concept1.md b/docs/_partials/concepts/general/concept1.md index 3cf7ef4285b4..00048ac54575 100644 --- a/docs/_partials/concepts/general/concept1.md +++ b/docs/_partials/concepts/general/concept1.md @@ -1 +1,11 @@ -Concept1 +**Concept1**: + +Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. +Nisi anim cupidatat excepteur officia. +Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. +Nostrud officia pariatur ut officia. + +Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. +Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. +Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. +Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. diff --git a/docs/creator/90_roadmap/_category_.yml b/docs/creator/90_roadmap/_category_.yml new file mode 100644 index 000000000000..74a6c2ee411d --- /dev/null +++ b/docs/creator/90_roadmap/_category_.yml @@ -0,0 +1 @@ +position: 90 diff --git a/docs/creator/90_roadmap/index.md b/docs/creator/90_roadmap/index.md new file mode 100644 index 000000000000..993b8b503621 --- /dev/null +++ b/docs/creator/90_roadmap/index.md @@ -0,0 +1,16 @@ +--- +title: "Learning Roadmap" +draft: true +--- + +import Introduction from '@site/docs/_partials/roadmap/intro.md' +import ReadingOrder from '@site/docs/_partials/roadmap/order.md' +import CreatorConcepts from '@site/docs/_partials/concepts/creator.md' + +# Creator Learning Roadmap + + +## Concepts List + + + From a7144ef4f54e7881b0a55cabb6286a7ad2013ab5 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Fri, 29 Mar 2024 18:44:19 +0100 Subject: [PATCH 10/33] new: Typescript Concepts full folder structure --- docs/_partials/concepts/typescript.md | 28 +++++++++++++------ docs/_partials/concepts/typescript/avatars.md | 12 ++++++++ .../concepts/typescript/avatars/animations.md | 0 .../typescript/avatars/description.md | 0 .../concepts/typescript/avatars/ik.md | 0 .../concepts/typescript/avatars/mocap.md | 0 .../typescript/avatars/retargeting.md | 0 docs/_partials/concepts/typescript/ecs.md | 11 ++++++++ .../concepts/typescript/ecs/components.md | 0 .../concepts/typescript/ecs/description.md | 0 .../concepts/typescript/ecs/eventSourcing.md | 0 .../concepts/typescript/ecs/queries.md | 0 .../concepts/typescript/ecs/systems.md | 5 ++++ .../typescript/ecs/systems/description.md | 0 .../typescript/ecs/systems/executionOrder.md | 7 +++++ .../ecs/systems/executionOrder/description.md | 0 .../ecs/systems/executionOrder/fixedRate.md | 0 .../ecs/systems/executionOrder/visualRate.md | 0 docs/_partials/concepts/typescript/inputs.md | 9 ++++++ .../concepts/typescript/inputs/description.md | 0 .../concepts/typescript/inputs/grabbables.md | 0 .../concepts/typescript/inputs/interaction.md | 0 .../concepts/typescript/inputs/spatial.md | 0 .../concepts/typescript/logicdata.md | 0 docs/_partials/concepts/typescript/mastery.md | 17 +++++++++++ .../concepts/typescript/mastery/cicd.md | 0 .../concepts/typescript/mastery/cms.md | 9 ++++++ .../concepts/typescript/mastery/cms/assets.md | 0 .../typescript/mastery/cms/description.md | 0 .../typescript/mastery/cms/projects.md | 0 .../concepts/typescript/mastery/cms/studio.md | 0 .../typescript/mastery/description.md | 0 .../concepts/typescript/mastery/engine.md | 7 +++++ .../typescript/mastery/engine/description.md | 0 .../typescript/mastery/engine/modules.md | 0 .../typescript/mastery/engine/navigation.md | 0 .../concepts/typescript/mastery/gltf.md | 0 .../concepts/typescript/mastery/rendering.md | 0 .../concepts/typescript/mastery/testing.md | 0 .../concepts/typescript/mastery/webxr.md | 0 .../concepts/typescript/networking.md | 7 +++++ .../concepts/typescript/networking/custom.md | 0 .../typescript/networking/description.md | 0 .../concepts/typescript/networking/simple.md | 0 docs/_partials/concepts/typescript/physics.md | 7 +++++ .../typescript/physics/description.md | 0 .../concepts/typescript/physics/simulation.md | 0 .../concepts/typescript/physics/triggers.md | 0 docs/_partials/concepts/typescript/social.md | 3 ++ .../concepts/typescript/social/description.md | 0 docs/_partials/concepts/typescript/state.md | 9 ++++++ .../concepts/typescript/state/description.md | 0 .../concepts/typescript/state/hyperflux.md | 0 .../concepts/typescript/state/reactivity.md | 0 .../concepts/typescript/state/reactors.md | 0 docs/_partials/concepts/typescript/xrui.md | 3 ++ .../concepts/typescript/xrui/description.md | 0 57 files changed, 126 insertions(+), 8 deletions(-) create mode 100644 docs/_partials/concepts/typescript/avatars.md create mode 100644 docs/_partials/concepts/typescript/avatars/animations.md create mode 100644 docs/_partials/concepts/typescript/avatars/description.md create mode 100644 docs/_partials/concepts/typescript/avatars/ik.md create mode 100644 docs/_partials/concepts/typescript/avatars/mocap.md create mode 100644 docs/_partials/concepts/typescript/avatars/retargeting.md create mode 100644 docs/_partials/concepts/typescript/ecs.md create mode 100644 docs/_partials/concepts/typescript/ecs/components.md create mode 100644 docs/_partials/concepts/typescript/ecs/description.md create mode 100644 docs/_partials/concepts/typescript/ecs/eventSourcing.md create mode 100644 docs/_partials/concepts/typescript/ecs/queries.md create mode 100644 docs/_partials/concepts/typescript/ecs/systems.md create mode 100644 docs/_partials/concepts/typescript/ecs/systems/description.md create mode 100644 docs/_partials/concepts/typescript/ecs/systems/executionOrder.md create mode 100644 docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md create mode 100644 docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md create mode 100644 docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md create mode 100644 docs/_partials/concepts/typescript/inputs.md create mode 100644 docs/_partials/concepts/typescript/inputs/description.md create mode 100644 docs/_partials/concepts/typescript/inputs/grabbables.md create mode 100644 docs/_partials/concepts/typescript/inputs/interaction.md create mode 100644 docs/_partials/concepts/typescript/inputs/spatial.md create mode 100644 docs/_partials/concepts/typescript/logicdata.md create mode 100644 docs/_partials/concepts/typescript/mastery.md create mode 100644 docs/_partials/concepts/typescript/mastery/cicd.md create mode 100644 docs/_partials/concepts/typescript/mastery/cms.md create mode 100644 docs/_partials/concepts/typescript/mastery/cms/assets.md create mode 100644 docs/_partials/concepts/typescript/mastery/cms/description.md create mode 100644 docs/_partials/concepts/typescript/mastery/cms/projects.md create mode 100644 docs/_partials/concepts/typescript/mastery/cms/studio.md create mode 100644 docs/_partials/concepts/typescript/mastery/description.md create mode 100644 docs/_partials/concepts/typescript/mastery/engine.md create mode 100644 docs/_partials/concepts/typescript/mastery/engine/description.md create mode 100644 docs/_partials/concepts/typescript/mastery/engine/modules.md create mode 100644 docs/_partials/concepts/typescript/mastery/engine/navigation.md create mode 100644 docs/_partials/concepts/typescript/mastery/gltf.md create mode 100644 docs/_partials/concepts/typescript/mastery/rendering.md create mode 100644 docs/_partials/concepts/typescript/mastery/testing.md create mode 100644 docs/_partials/concepts/typescript/mastery/webxr.md create mode 100644 docs/_partials/concepts/typescript/networking.md create mode 100644 docs/_partials/concepts/typescript/networking/custom.md create mode 100644 docs/_partials/concepts/typescript/networking/description.md create mode 100644 docs/_partials/concepts/typescript/networking/simple.md create mode 100644 docs/_partials/concepts/typescript/physics.md create mode 100644 docs/_partials/concepts/typescript/physics/description.md create mode 100644 docs/_partials/concepts/typescript/physics/simulation.md create mode 100644 docs/_partials/concepts/typescript/physics/triggers.md create mode 100644 docs/_partials/concepts/typescript/social.md create mode 100644 docs/_partials/concepts/typescript/social/description.md create mode 100644 docs/_partials/concepts/typescript/state.md create mode 100644 docs/_partials/concepts/typescript/state/description.md create mode 100644 docs/_partials/concepts/typescript/state/hyperflux.md create mode 100644 docs/_partials/concepts/typescript/state/reactivity.md create mode 100644 docs/_partials/concepts/typescript/state/reactors.md create mode 100644 docs/_partials/concepts/typescript/xrui.md create mode 100644 docs/_partials/concepts/typescript/xrui/description.md diff --git a/docs/_partials/concepts/typescript.md b/docs/_partials/concepts/typescript.md index 87471365653f..f55ce8cece55 100644 --- a/docs/_partials/concepts/typescript.md +++ b/docs/_partials/concepts/typescript.md @@ -1,9 +1,21 @@ +import Avatars from './typescript/avatars.md' +import ECS from './typescript/ecs.md' +import Inputs from './typescript/inputs.md' +import Logicdata from './typescript/logicdata.md' +import Mastery from './typescript/mastery.md' +import Networking from './typescript/networking.md' +import Physics from './typescript/physics.md' +import Social from './typescript/social.md' +import State from './typescript/state.md' +import XRUI from './typescript/xrui.md' -import Concept1 from '@site/docs/_partials/concepts/typescript/concept1.md' - - - - - - - + + + + + + + + + + diff --git a/docs/_partials/concepts/typescript/avatars.md b/docs/_partials/concepts/typescript/avatars.md new file mode 100644 index 000000000000..5e8f320e6c80 --- /dev/null +++ b/docs/_partials/concepts/typescript/avatars.md @@ -0,0 +1,12 @@ +import Description from './avatars/description.md' +import Animations from './avatars/animations.md' +import IK from './avatars/ik.md' +import Mocap from './avatars/mocap.md' +import Retargeting from './avatars/retargeting.md' + + + + + + + diff --git a/docs/_partials/concepts/typescript/avatars/animations.md b/docs/_partials/concepts/typescript/avatars/animations.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/avatars/description.md b/docs/_partials/concepts/typescript/avatars/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/avatars/ik.md b/docs/_partials/concepts/typescript/avatars/ik.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/avatars/mocap.md b/docs/_partials/concepts/typescript/avatars/mocap.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/avatars/retargeting.md b/docs/_partials/concepts/typescript/avatars/retargeting.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/ecs.md b/docs/_partials/concepts/typescript/ecs.md new file mode 100644 index 000000000000..eef4c97dc7a2 --- /dev/null +++ b/docs/_partials/concepts/typescript/ecs.md @@ -0,0 +1,11 @@ +import Description from './ecs/description.md' +import Components from './ecs/components.md' +import EventSourcing from './ecs/eventSourcing.md' +import Queries from './ecs/queries.md' +import Systems from './ecs/systems.md' + + + + + + diff --git a/docs/_partials/concepts/typescript/ecs/components.md b/docs/_partials/concepts/typescript/ecs/components.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/ecs/description.md b/docs/_partials/concepts/typescript/ecs/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/ecs/eventSourcing.md b/docs/_partials/concepts/typescript/ecs/eventSourcing.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/ecs/queries.md b/docs/_partials/concepts/typescript/ecs/queries.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/ecs/systems.md b/docs/_partials/concepts/typescript/ecs/systems.md new file mode 100644 index 000000000000..914b88ea75e8 --- /dev/null +++ b/docs/_partials/concepts/typescript/ecs/systems.md @@ -0,0 +1,5 @@ +import Description from './systems/description.md' +import ExecutionOrder from './systems/executionOrder.md' + + + diff --git a/docs/_partials/concepts/typescript/ecs/systems/description.md b/docs/_partials/concepts/typescript/ecs/systems/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder.md new file mode 100644 index 000000000000..1be213c6c2b9 --- /dev/null +++ b/docs/_partials/concepts/typescript/ecs/systems/executionOrder.md @@ -0,0 +1,7 @@ +import Description from './executionOrder/description.md' +import FixedRate from './executionOrder/fixedRate.md' +import VisualRate from './executionOrder/visualRate.md' + + + + diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/inputs.md b/docs/_partials/concepts/typescript/inputs.md new file mode 100644 index 000000000000..d74951e46bed --- /dev/null +++ b/docs/_partials/concepts/typescript/inputs.md @@ -0,0 +1,9 @@ +import Description from './inputs/description.md' +import Grabbables from './inputs/grabbables.md' +import Interaction from './inputs/interaction.md' +import Spatial from './inputs/spatial.md' + + + + + diff --git a/docs/_partials/concepts/typescript/inputs/description.md b/docs/_partials/concepts/typescript/inputs/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/inputs/grabbables.md b/docs/_partials/concepts/typescript/inputs/grabbables.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/inputs/interaction.md b/docs/_partials/concepts/typescript/inputs/interaction.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/inputs/spatial.md b/docs/_partials/concepts/typescript/inputs/spatial.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/logicdata.md b/docs/_partials/concepts/typescript/logicdata.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery.md b/docs/_partials/concepts/typescript/mastery.md new file mode 100644 index 000000000000..4dc5c580d890 --- /dev/null +++ b/docs/_partials/concepts/typescript/mastery.md @@ -0,0 +1,17 @@ +import Description from './mastery/description.md' +import CICD from './mastery/cicd.md' +import CMS from './mastery/cms.md' +import Engine from './mastery/engine.md' +import glTF from './mastery/gltf.md' +import Rendering from './mastery/rendering.md' +import Testing from './mastery/testing.md' +import WebXR from './mastery/webxr.md' + + + + + + + + + diff --git a/docs/_partials/concepts/typescript/mastery/cicd.md b/docs/_partials/concepts/typescript/mastery/cicd.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/cms.md b/docs/_partials/concepts/typescript/mastery/cms.md new file mode 100644 index 000000000000..7823072fd4b4 --- /dev/null +++ b/docs/_partials/concepts/typescript/mastery/cms.md @@ -0,0 +1,9 @@ +import Description from './cms/description.md' +import Studio from './cms/studio.md' +import Projects from './cms/projects.md' +import Assets from './cms/assets.md' + + + + + diff --git a/docs/_partials/concepts/typescript/mastery/cms/assets.md b/docs/_partials/concepts/typescript/mastery/cms/assets.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/cms/description.md b/docs/_partials/concepts/typescript/mastery/cms/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/cms/projects.md b/docs/_partials/concepts/typescript/mastery/cms/projects.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/cms/studio.md b/docs/_partials/concepts/typescript/mastery/cms/studio.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/description.md b/docs/_partials/concepts/typescript/mastery/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/engine.md b/docs/_partials/concepts/typescript/mastery/engine.md new file mode 100644 index 000000000000..638fcbc215bd --- /dev/null +++ b/docs/_partials/concepts/typescript/mastery/engine.md @@ -0,0 +1,7 @@ +import Description from './engine/description.md' +import Navigation from './engine/navigation.md' +import Modules from './engine/modules.md' + + + + diff --git a/docs/_partials/concepts/typescript/mastery/engine/description.md b/docs/_partials/concepts/typescript/mastery/engine/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/engine/modules.md b/docs/_partials/concepts/typescript/mastery/engine/modules.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/engine/navigation.md b/docs/_partials/concepts/typescript/mastery/engine/navigation.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/gltf.md b/docs/_partials/concepts/typescript/mastery/gltf.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/rendering.md b/docs/_partials/concepts/typescript/mastery/rendering.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/testing.md b/docs/_partials/concepts/typescript/mastery/testing.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/mastery/webxr.md b/docs/_partials/concepts/typescript/mastery/webxr.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/networking.md b/docs/_partials/concepts/typescript/networking.md new file mode 100644 index 000000000000..3ce2fbefdf80 --- /dev/null +++ b/docs/_partials/concepts/typescript/networking.md @@ -0,0 +1,7 @@ +import Description from './networking/description.md' +import Simple from './networking/simple.md' +import Custom from './networking/custom.md' + + + + diff --git a/docs/_partials/concepts/typescript/networking/custom.md b/docs/_partials/concepts/typescript/networking/custom.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/networking/description.md b/docs/_partials/concepts/typescript/networking/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/networking/simple.md b/docs/_partials/concepts/typescript/networking/simple.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/physics.md b/docs/_partials/concepts/typescript/physics.md new file mode 100644 index 000000000000..db53ad982577 --- /dev/null +++ b/docs/_partials/concepts/typescript/physics.md @@ -0,0 +1,7 @@ +import Description from './physics/description.md' +import Simulation from './physics/simulation.md' +import Triggers from './physics/triggers.md' + + + + diff --git a/docs/_partials/concepts/typescript/physics/description.md b/docs/_partials/concepts/typescript/physics/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/physics/simulation.md b/docs/_partials/concepts/typescript/physics/simulation.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/physics/triggers.md b/docs/_partials/concepts/typescript/physics/triggers.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/social.md b/docs/_partials/concepts/typescript/social.md new file mode 100644 index 000000000000..0df5a28332ee --- /dev/null +++ b/docs/_partials/concepts/typescript/social.md @@ -0,0 +1,3 @@ +import Description from './social/description.md' + + diff --git a/docs/_partials/concepts/typescript/social/description.md b/docs/_partials/concepts/typescript/social/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/state.md b/docs/_partials/concepts/typescript/state.md new file mode 100644 index 000000000000..e254b84e2342 --- /dev/null +++ b/docs/_partials/concepts/typescript/state.md @@ -0,0 +1,9 @@ +import Description from './state/description.md' +import Hyperflux from './state/hyperflux.md' +import Reactors from './state/reactors.md' +import Reactivity from './state/reactivity.md' + + + + + diff --git a/docs/_partials/concepts/typescript/state/description.md b/docs/_partials/concepts/typescript/state/description.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/state/hyperflux.md b/docs/_partials/concepts/typescript/state/hyperflux.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/state/reactivity.md b/docs/_partials/concepts/typescript/state/reactivity.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/state/reactors.md b/docs/_partials/concepts/typescript/state/reactors.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/_partials/concepts/typescript/xrui.md b/docs/_partials/concepts/typescript/xrui.md new file mode 100644 index 000000000000..26ab6769d87b --- /dev/null +++ b/docs/_partials/concepts/typescript/xrui.md @@ -0,0 +1,3 @@ +import Description from './xrui/description.md' + + diff --git a/docs/_partials/concepts/typescript/xrui/description.md b/docs/_partials/concepts/typescript/xrui/description.md new file mode 100644 index 000000000000..e69de29bb2d1 From 3e756bfee6e23c26fe44971844d68f8f2a266e58 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Fri, 29 Mar 2024 19:26:12 +0100 Subject: [PATCH 11/33] new: Mockup definitions for all Typescript concepts --- docs/_partials/concepts/typescript/avatars/animations.md | 2 ++ docs/_partials/concepts/typescript/avatars/description.md | 3 +++ docs/_partials/concepts/typescript/avatars/ik.md | 3 +++ docs/_partials/concepts/typescript/avatars/mocap.md | 3 +++ docs/_partials/concepts/typescript/avatars/retargeting.md | 3 +++ docs/_partials/concepts/typescript/ecs/components.md | 2 ++ docs/_partials/concepts/typescript/ecs/description.md | 3 +++ docs/_partials/concepts/typescript/ecs/eventSourcing.md | 3 +++ docs/_partials/concepts/typescript/ecs/queries.md | 3 +++ docs/_partials/concepts/typescript/ecs/systems/description.md | 3 +++ .../typescript/ecs/systems/executionOrder/description.md | 2 ++ .../typescript/ecs/systems/executionOrder/fixedRate.md | 3 +++ .../typescript/ecs/systems/executionOrder/visualRate.md | 3 +++ docs/_partials/concepts/typescript/inputs/description.md | 3 +++ docs/_partials/concepts/typescript/inputs/grabbables.md | 3 +++ docs/_partials/concepts/typescript/inputs/interaction.md | 3 +++ docs/_partials/concepts/typescript/inputs/spatial.md | 3 +++ docs/_partials/concepts/typescript/logicdata.md | 3 +++ docs/_partials/concepts/typescript/mastery/cicd.md | 3 +++ docs/_partials/concepts/typescript/mastery/cms/assets.md | 3 +++ docs/_partials/concepts/typescript/mastery/cms/description.md | 3 +++ docs/_partials/concepts/typescript/mastery/cms/projects.md | 3 +++ docs/_partials/concepts/typescript/mastery/cms/studio.md | 3 +++ docs/_partials/concepts/typescript/mastery/description.md | 3 +++ .../concepts/typescript/mastery/engine/description.md | 3 +++ docs/_partials/concepts/typescript/mastery/engine/modules.md | 3 +++ .../_partials/concepts/typescript/mastery/engine/navigation.md | 3 +++ docs/_partials/concepts/typescript/mastery/gltf.md | 3 +++ docs/_partials/concepts/typescript/mastery/rendering.md | 3 +++ docs/_partials/concepts/typescript/mastery/testing.md | 3 +++ docs/_partials/concepts/typescript/mastery/webxr.md | 3 +++ docs/_partials/concepts/typescript/networking/custom.md | 3 +++ docs/_partials/concepts/typescript/networking/description.md | 3 +++ docs/_partials/concepts/typescript/networking/simple.md | 3 +++ docs/_partials/concepts/typescript/physics/description.md | 3 +++ docs/_partials/concepts/typescript/physics/simulation.md | 3 +++ docs/_partials/concepts/typescript/physics/triggers.md | 3 +++ docs/_partials/concepts/typescript/social/description.md | 3 +++ docs/_partials/concepts/typescript/state/description.md | 3 +++ docs/_partials/concepts/typescript/state/hyperflux.md | 3 +++ docs/_partials/concepts/typescript/state/reactivity.md | 3 +++ docs/_partials/concepts/typescript/state/reactors.md | 3 +++ docs/_partials/concepts/typescript/xrui/description.md | 3 +++ 43 files changed, 126 insertions(+) diff --git a/docs/_partials/concepts/typescript/avatars/animations.md b/docs/_partials/concepts/typescript/avatars/animations.md index e69de29bb2d1..fe55fda3ebbc 100644 --- a/docs/_partials/concepts/typescript/avatars/animations.md +++ b/docs/_partials/concepts/typescript/avatars/animations.md @@ -0,0 +1,2 @@ +**Animations**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. diff --git a/docs/_partials/concepts/typescript/avatars/description.md b/docs/_partials/concepts/typescript/avatars/description.md index e69de29bb2d1..7dd72c7b5805 100644 --- a/docs/_partials/concepts/typescript/avatars/description.md +++ b/docs/_partials/concepts/typescript/avatars/description.md @@ -0,0 +1,3 @@ +**Avatars**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/avatars/ik.md b/docs/_partials/concepts/typescript/avatars/ik.md index e69de29bb2d1..e6a8ac8bffa1 100644 --- a/docs/_partials/concepts/typescript/avatars/ik.md +++ b/docs/_partials/concepts/typescript/avatars/ik.md @@ -0,0 +1,3 @@ +**Inverse Kinematics**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/avatars/mocap.md b/docs/_partials/concepts/typescript/avatars/mocap.md index e69de29bb2d1..54428ae9b4f1 100644 --- a/docs/_partials/concepts/typescript/avatars/mocap.md +++ b/docs/_partials/concepts/typescript/avatars/mocap.md @@ -0,0 +1,3 @@ +**Motion Capture**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/avatars/retargeting.md b/docs/_partials/concepts/typescript/avatars/retargeting.md index e69de29bb2d1..b1ebd47eaf52 100644 --- a/docs/_partials/concepts/typescript/avatars/retargeting.md +++ b/docs/_partials/concepts/typescript/avatars/retargeting.md @@ -0,0 +1,3 @@ +**Retargeting**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/components.md b/docs/_partials/concepts/typescript/ecs/components.md index e69de29bb2d1..69d3e68fa916 100644 --- a/docs/_partials/concepts/typescript/ecs/components.md +++ b/docs/_partials/concepts/typescript/ecs/components.md @@ -0,0 +1,2 @@ +**Components**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. diff --git a/docs/_partials/concepts/typescript/ecs/description.md b/docs/_partials/concepts/typescript/ecs/description.md index e69de29bb2d1..53b4840e911f 100644 --- a/docs/_partials/concepts/typescript/ecs/description.md +++ b/docs/_partials/concepts/typescript/ecs/description.md @@ -0,0 +1,3 @@ +**Entity Component System**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/eventSourcing.md b/docs/_partials/concepts/typescript/ecs/eventSourcing.md index e69de29bb2d1..aeb0aca4ad9d 100644 --- a/docs/_partials/concepts/typescript/ecs/eventSourcing.md +++ b/docs/_partials/concepts/typescript/ecs/eventSourcing.md @@ -0,0 +1,3 @@ +**Event Sourcing**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/queries.md b/docs/_partials/concepts/typescript/ecs/queries.md index e69de29bb2d1..c574acaeed3d 100644 --- a/docs/_partials/concepts/typescript/ecs/queries.md +++ b/docs/_partials/concepts/typescript/ecs/queries.md @@ -0,0 +1,3 @@ +**Queries**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/systems/description.md b/docs/_partials/concepts/typescript/ecs/systems/description.md index e69de29bb2d1..e45c1c858680 100644 --- a/docs/_partials/concepts/typescript/ecs/systems/description.md +++ b/docs/_partials/concepts/typescript/ecs/systems/description.md @@ -0,0 +1,3 @@ +**Systems**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md index e69de29bb2d1..a63f197feb4e 100644 --- a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md +++ b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md @@ -0,0 +1,2 @@ +**Execution Order**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md index e69de29bb2d1..4ea9011d993c 100644 --- a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md +++ b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md @@ -0,0 +1,3 @@ +**Fixed Rate**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md index e69de29bb2d1..63395c75e7f3 100644 --- a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md +++ b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md @@ -0,0 +1,3 @@ +**Visual Rate**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/inputs/description.md b/docs/_partials/concepts/typescript/inputs/description.md index e69de29bb2d1..524196605ab9 100644 --- a/docs/_partials/concepts/typescript/inputs/description.md +++ b/docs/_partials/concepts/typescript/inputs/description.md @@ -0,0 +1,3 @@ +**Inputs System**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/inputs/grabbables.md b/docs/_partials/concepts/typescript/inputs/grabbables.md index e69de29bb2d1..a08b42c3e360 100644 --- a/docs/_partials/concepts/typescript/inputs/grabbables.md +++ b/docs/_partials/concepts/typescript/inputs/grabbables.md @@ -0,0 +1,3 @@ +**Grabbables**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/inputs/interaction.md b/docs/_partials/concepts/typescript/inputs/interaction.md index e69de29bb2d1..2adf93d7eb0e 100644 --- a/docs/_partials/concepts/typescript/inputs/interaction.md +++ b/docs/_partials/concepts/typescript/inputs/interaction.md @@ -0,0 +1,3 @@ +**Interaction System**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/inputs/spatial.md b/docs/_partials/concepts/typescript/inputs/spatial.md index e69de29bb2d1..8ef1858aae73 100644 --- a/docs/_partials/concepts/typescript/inputs/spatial.md +++ b/docs/_partials/concepts/typescript/inputs/spatial.md @@ -0,0 +1,3 @@ +**Spatial Inputs**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/logicdata.md b/docs/_partials/concepts/typescript/logicdata.md index e69de29bb2d1..7b9e70ce4ae8 100644 --- a/docs/_partials/concepts/typescript/logicdata.md +++ b/docs/_partials/concepts/typescript/logicdata.md @@ -0,0 +1,3 @@ +**Logic vs Data**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cicd.md b/docs/_partials/concepts/typescript/mastery/cicd.md index e69de29bb2d1..c7e641d673b7 100644 --- a/docs/_partials/concepts/typescript/mastery/cicd.md +++ b/docs/_partials/concepts/typescript/mastery/cicd.md @@ -0,0 +1,3 @@ +**CI/CD**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cms/assets.md b/docs/_partials/concepts/typescript/mastery/cms/assets.md index e69de29bb2d1..14e4d1aa3e63 100644 --- a/docs/_partials/concepts/typescript/mastery/cms/assets.md +++ b/docs/_partials/concepts/typescript/mastery/cms/assets.md @@ -0,0 +1,3 @@ +**Assets**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cms/description.md b/docs/_partials/concepts/typescript/mastery/cms/description.md index e69de29bb2d1..0af284b8bbc5 100644 --- a/docs/_partials/concepts/typescript/mastery/cms/description.md +++ b/docs/_partials/concepts/typescript/mastery/cms/description.md @@ -0,0 +1,3 @@ +**CMS**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cms/projects.md b/docs/_partials/concepts/typescript/mastery/cms/projects.md index e69de29bb2d1..40e8853a4557 100644 --- a/docs/_partials/concepts/typescript/mastery/cms/projects.md +++ b/docs/_partials/concepts/typescript/mastery/cms/projects.md @@ -0,0 +1,3 @@ +**Projects**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cms/studio.md b/docs/_partials/concepts/typescript/mastery/cms/studio.md index e69de29bb2d1..76acd3a338a0 100644 --- a/docs/_partials/concepts/typescript/mastery/cms/studio.md +++ b/docs/_partials/concepts/typescript/mastery/cms/studio.md @@ -0,0 +1,3 @@ +**Studio**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/description.md b/docs/_partials/concepts/typescript/mastery/description.md index e69de29bb2d1..1630c1c82bfd 100644 --- a/docs/_partials/concepts/typescript/mastery/description.md +++ b/docs/_partials/concepts/typescript/mastery/description.md @@ -0,0 +1,3 @@ +**Mastery Toolkit**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/engine/description.md b/docs/_partials/concepts/typescript/mastery/engine/description.md index e69de29bb2d1..5613221cbd80 100644 --- a/docs/_partials/concepts/typescript/mastery/engine/description.md +++ b/docs/_partials/concepts/typescript/mastery/engine/description.md @@ -0,0 +1,3 @@ +**Engine**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/engine/modules.md b/docs/_partials/concepts/typescript/mastery/engine/modules.md index e69de29bb2d1..dad8cf17e49c 100644 --- a/docs/_partials/concepts/typescript/mastery/engine/modules.md +++ b/docs/_partials/concepts/typescript/mastery/engine/modules.md @@ -0,0 +1,3 @@ +**Modules**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/engine/navigation.md b/docs/_partials/concepts/typescript/mastery/engine/navigation.md index e69de29bb2d1..a6afe775fdb0 100644 --- a/docs/_partials/concepts/typescript/mastery/engine/navigation.md +++ b/docs/_partials/concepts/typescript/mastery/engine/navigation.md @@ -0,0 +1,3 @@ +**Navigation**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/gltf.md b/docs/_partials/concepts/typescript/mastery/gltf.md index e69de29bb2d1..6c4d72c2a44e 100644 --- a/docs/_partials/concepts/typescript/mastery/gltf.md +++ b/docs/_partials/concepts/typescript/mastery/gltf.md @@ -0,0 +1,3 @@ +**glTF**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/rendering.md b/docs/_partials/concepts/typescript/mastery/rendering.md index e69de29bb2d1..5bc12e0614d2 100644 --- a/docs/_partials/concepts/typescript/mastery/rendering.md +++ b/docs/_partials/concepts/typescript/mastery/rendering.md @@ -0,0 +1,3 @@ +**Rendering**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/testing.md b/docs/_partials/concepts/typescript/mastery/testing.md index e69de29bb2d1..74805f429002 100644 --- a/docs/_partials/concepts/typescript/mastery/testing.md +++ b/docs/_partials/concepts/typescript/mastery/testing.md @@ -0,0 +1,3 @@ +**Unit Testing**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/webxr.md b/docs/_partials/concepts/typescript/mastery/webxr.md index e69de29bb2d1..b3450ebc1415 100644 --- a/docs/_partials/concepts/typescript/mastery/webxr.md +++ b/docs/_partials/concepts/typescript/mastery/webxr.md @@ -0,0 +1,3 @@ +**WebXR**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/networking/custom.md b/docs/_partials/concepts/typescript/networking/custom.md index e69de29bb2d1..78853af06b0a 100644 --- a/docs/_partials/concepts/typescript/networking/custom.md +++ b/docs/_partials/concepts/typescript/networking/custom.md @@ -0,0 +1,3 @@ +**Custom Networking**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/networking/description.md b/docs/_partials/concepts/typescript/networking/description.md index e69de29bb2d1..5c5c54f5daa5 100644 --- a/docs/_partials/concepts/typescript/networking/description.md +++ b/docs/_partials/concepts/typescript/networking/description.md @@ -0,0 +1,3 @@ +**Networking**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/networking/simple.md b/docs/_partials/concepts/typescript/networking/simple.md index e69de29bb2d1..be7ad847aafe 100644 --- a/docs/_partials/concepts/typescript/networking/simple.md +++ b/docs/_partials/concepts/typescript/networking/simple.md @@ -0,0 +1,3 @@ +**Networking (`spawnEntity()`)**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/physics/description.md b/docs/_partials/concepts/typescript/physics/description.md index e69de29bb2d1..551a64737da3 100644 --- a/docs/_partials/concepts/typescript/physics/description.md +++ b/docs/_partials/concepts/typescript/physics/description.md @@ -0,0 +1,3 @@ +**Physics**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/physics/simulation.md b/docs/_partials/concepts/typescript/physics/simulation.md index e69de29bb2d1..d801b381a1c8 100644 --- a/docs/_partials/concepts/typescript/physics/simulation.md +++ b/docs/_partials/concepts/typescript/physics/simulation.md @@ -0,0 +1,3 @@ +**Physics Simulation**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/physics/triggers.md b/docs/_partials/concepts/typescript/physics/triggers.md index e69de29bb2d1..1fba423c1fa4 100644 --- a/docs/_partials/concepts/typescript/physics/triggers.md +++ b/docs/_partials/concepts/typescript/physics/triggers.md @@ -0,0 +1,3 @@ +**Triggers**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/social/description.md b/docs/_partials/concepts/typescript/social/description.md index e69de29bb2d1..9c438efddfcc 100644 --- a/docs/_partials/concepts/typescript/social/description.md +++ b/docs/_partials/concepts/typescript/social/description.md @@ -0,0 +1,3 @@ +**Social System**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/state/description.md b/docs/_partials/concepts/typescript/state/description.md index e69de29bb2d1..2ef9bc691041 100644 --- a/docs/_partials/concepts/typescript/state/description.md +++ b/docs/_partials/concepts/typescript/state/description.md @@ -0,0 +1,3 @@ +**State**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/state/hyperflux.md b/docs/_partials/concepts/typescript/state/hyperflux.md index e69de29bb2d1..66b92b2b775e 100644 --- a/docs/_partials/concepts/typescript/state/hyperflux.md +++ b/docs/_partials/concepts/typescript/state/hyperflux.md @@ -0,0 +1,3 @@ +**Hyperflux**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/state/reactivity.md b/docs/_partials/concepts/typescript/state/reactivity.md index e69de29bb2d1..e0097cc91bff 100644 --- a/docs/_partials/concepts/typescript/state/reactivity.md +++ b/docs/_partials/concepts/typescript/state/reactivity.md @@ -0,0 +1,3 @@ +**Reactivity**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/state/reactors.md b/docs/_partials/concepts/typescript/state/reactors.md index e69de29bb2d1..0bb320c3497c 100644 --- a/docs/_partials/concepts/typescript/state/reactors.md +++ b/docs/_partials/concepts/typescript/state/reactors.md @@ -0,0 +1,3 @@ +**Reactors**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/xrui/description.md b/docs/_partials/concepts/typescript/xrui/description.md index e69de29bb2d1..50f5d435896e 100644 --- a/docs/_partials/concepts/typescript/xrui/description.md +++ b/docs/_partials/concepts/typescript/xrui/description.md @@ -0,0 +1,3 @@ +**XRUI**: +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + From e3a0c351d00f68c7e7913557b84bfcf4a5aa51d2 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Fri, 29 Mar 2024 19:41:47 +0100 Subject: [PATCH 12/33] rmv: Concepts1 mockup file --- docs/_partials/concepts/typescript/concept1.md | 11 ----------- 1 file changed, 11 deletions(-) delete mode 100644 docs/_partials/concepts/typescript/concept1.md diff --git a/docs/_partials/concepts/typescript/concept1.md b/docs/_partials/concepts/typescript/concept1.md deleted file mode 100644 index 00048ac54575..000000000000 --- a/docs/_partials/concepts/typescript/concept1.md +++ /dev/null @@ -1,11 +0,0 @@ -**Concept1**: - -Lorem ipsum dolor sit amet, officia excepteur ex fugiat reprehenderit enim labore culpa sint ad nisi Lorem pariatur mollit ex esse exercitation amet. -Nisi anim cupidatat excepteur officia. -Reprehenderit nostrud nostrud ipsum Lorem est aliquip amet voluptate voluptate dolor minim nulla est proident. -Nostrud officia pariatur ut officia. - -Sit irure elit esse ea nulla sunt ex occaecat reprehenderit commodo officia dolor Lorem duis laboris cupidatat officia voluptate. -Culpa proident adipisicing id nulla nisi laboris ex in Lorem sunt duis officia eiusmod. -Aliqua reprehenderit commodo ex non excepteur duis sunt velit enim. -Voluptate laboris sint cupidatat ullamco ut ea consectetur et est culpa et culpa duis. From 88da170e891e04c7834897c6e02f16e5afc306c0 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Sat, 30 Mar 2024 11:02:31 +0100 Subject: [PATCH 13/33] new: Concepts Component. Internal database + hover + block generator --- docs/_partials/roadmap/dummy.md | 10 ++ src/components/Concept.tsx | 244 ++++++++++++++++++++++++++++++++ 2 files changed, 254 insertions(+) create mode 100644 docs/_partials/roadmap/dummy.md create mode 100644 src/components/Concept.tsx diff --git a/docs/_partials/roadmap/dummy.md b/docs/_partials/roadmap/dummy.md new file mode 100644 index 000000000000..03c969e50dc4 --- /dev/null +++ b/docs/_partials/roadmap/dummy.md @@ -0,0 +1,10 @@ +import { Concept } from '@site/src/components/Concept' + +This is a dummy text for a new mastery concept. + +This is a . Then some other thing on the same line. + +

+The block of text below is auto-generated with the same component: + + diff --git a/src/components/Concept.tsx b/src/components/Concept.tsx new file mode 100644 index 000000000000..215b43418bc8 --- /dev/null +++ b/src/components/Concept.tsx @@ -0,0 +1,244 @@ +import Error from '@theme/Error'; +import React from 'react'; +import { clsx as mergex } from 'clsx' + + +/* + * @internal + * @description Describes the Kinds that Concepts can be tagged with + */ +enum ConceptKind { + core = "Core", + advanced = "Advanced", + mastery = "Mastery", +} +/* + * @internal + * @description Describes the Categories that Concepts can be tagged with + */ +enum ConceptCategory { + creator = "Creator", + visualscript = "Visualscript", + typescript = "Typescript", + general = "General", +} +/* + * @internal + * @description Describes the data stored and required for each concept + */ +type ConceptData = { + title : string + kind : ConceptKind + category : ConceptCategory + description : string +} +/* + * @internal + * @description Dummy concept. Used for debugging / testing + */ +const Dummy :ConceptData= { + title : "Untitled Concept", + kind : ConceptKind.core, + category : ConceptCategory.general, + description : " Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.", +} +/* + * @internal + * @description Alias for the type of Map that stores the Concepts registered by the documentation. + */ +type ConceptsMap = Map; +/* + * @internal + * @description Stores the list of Concepts registered by the documentation. + */ +const ConceptList :ConceptsMap= new Map(); +// Add a dummy concept for testing/debugging +ConceptList.set("Debug Concept", { + title : "Debug Concept", + kind : ConceptKind.core, + category : ConceptCategory.general, + description : "Debug Concept. Some Dummy Description. Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat." + }) + + +/* + * @description Adds a new Concept to the internal list of concepts + * @note + * Implicitly called whenever a new unmapped Concept is rendered for the first time. + * This function will not be called if the `Concept.temporary` property is set to `true` when rendering the Concept for the first time. + */ +export function addConcept( + title : string, + kind : ConceptKind, + category : ConceptCategory, + description : string + ) :void { + const data :ConceptData= {title: title, description: description, kind: kind, category: category} + ConceptList.set(title, data) +} + + +/* + * @internal + * @description Renders the onHover Card of a Concept + */ +const ConceptInlineTooltip = (props) => { + // Tooltip General Style + const Align = "absolute flex flex-col basis-1/3 px-4 py-2 left-1/2 -translate-x-1/2 -translate-y-full -m-8" + const Visibility = "opacity-0 peer-hover:opacity-100" // Make it visible only when peer (aka the Inline Text) is hovered. + const Transition = "transition-opacity" + const Text = "text-sm" + const Shape = "rounded-md" + const BG = "bg-blue-800" + const Tooltip = mergex(Align, Visibility, Transition, Text, Align, Shape, BG) + // Top Section Style + const Top = "flex justify-between pb-2" + const Title = "font-bold" + const Meta = "flex-auto text-end" + const Essential = "flex-auto text-right italic text-xs align-bottom align-text-bottom" + // Description style + const Description = "text-justify" + // Figure out if the concept is essential or not, and add the text to the Top Section + const essentialText = props.kind == ConceptKind.core ? "Essential" : (props.kind == ConceptKind.advanced) ? "Non-Essential" : ""; + // Render the Component + return ( +
+
+ {props.title} + {essentialText} + Type: {props.category} {props.kind} Concept
+
+ {props.children} +
+ ); +} + +/* + * @internal + * @description Renders a Concept as an inline Link+Card. + */ +const ConceptInline = (props) => { + const Peer = "peer" // Mark the text as the Peer for the onHover to react to + const Text = mergex(Peer, "text-blue-500 underline underline-offset-8") + return ( + + {props.title} + + {props.children} + + + ); +} + +/* + * @internal + * @description Renders a Concept as a Paragraph / Block of text. + */ +const ConceptBlock = (props) => { + // Text Content + const AfterTitle = ": " + // CSS + const Title = "font-bold" + const Container = "" + // Return the component HTML Fragment + return ( +
+ {props.title}{AfterTitle}
+ {props.children} +

+ ) +} + +/* + * @internal + * @description Picks which type of Component will be rendered, based on the passed properties/data + */ +const ConceptSelector = (props) => { + return (props.block + ? {props.children} + : {props.children} + ) +} + + +/* + * @internal + * @description Renders a Concept based on the passed properties/data + */ +const UnknownConcept = (props) => { + // Replace with Dummy text when omitted + const Title = props.title ? props.title : Dummy.title + const Kind = props.kind ? props.kind : Dummy.kind + const Category = props.category ? props.category : Dummy.category + const Body = props.children ? props.children : Dummy.description + // Store the concept into `ConceptList` when it hasn't been yet, and `temporar=` is not set to true + if (!props.temporary && !ConceptList.has(Title)) addConcept(Title, Kind, Category, Body) + // Return the component HTML Fragment + return ({Body}) +} +/* + * @internal + * @description Renders a Concept based on the data stored into `ConceptList` for the given `title=` property + */ +const KnownConcept = (props) => { + // Replace with text from the ConceptList, based on the passed `title=` value + // TODO : FIXME: Massive hack. + // : How to access Map fields by a string? + // : They don't work for some reason :thinking: + // const Title = ConceptList[props.title].Title + // const Kind = ConceptList[props.title].kind + // const Category = ConceptList[props.title].category + // const Body = ConceptList[props.title].description + let fixme :ConceptData + ConceptList.forEach((value: ConceptData, key: string) => { if (key == props.title) fixme = value }); + const Title = fixme.title + const Kind = fixme.kind + const Category = fixme.category + const Body = fixme.description + // END: End of the hack + return ({Body}) +} + + +/* + * @description + * Renders a Concept into the page + * It can define just a title if the Concept has already been added to the list before. + * The fields `kind`, `category` and `children` are required whenever a new Concept is being requested to be rendered before adding it manually beforehand. + * + * @param title The Concept's title. Will be used to search the internal list of already known concepts. + * @param kind The Concept's kind. Accepts only valid {@link ConceptKind} fields. + * @param category The Concept's category. Accepts only valid {@link ConceptCategory} fields. + * @param children The body of the Concept's description. + * @param block Will render the Concept as a block of text when true. Will render inline otherwise. + * @param temporary Will skip adding the Concept to the internal Concepts list when true. + */ +export const Concept = (props) => { + if (ConceptList.has(props.title)) { + // Assert that component properties other than the title are undefined + // TODO: How to do this properly? + if (props.kind) throw Error(null) + if (props.category) throw Error(null) + if (props.children) throw Error(null) + // Render the Concept from the known ConceptList + return (); + } else { + // Render a Concept from the data passed to the component + return ( + + {props.children} + + ); + } +}; + From 1d099892b3a088368d18e7e86d3c6a9f21d7c48a Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 2 Apr 2024 17:15:42 +0200 Subject: [PATCH 14/33] doc: Improve the Concept component usage example in the dummy.md file --- docs/_partials/roadmap/dummy.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/_partials/roadmap/dummy.md b/docs/_partials/roadmap/dummy.md index 03c969e50dc4..2989fb947f8b 100644 --- a/docs/_partials/roadmap/dummy.md +++ b/docs/_partials/roadmap/dummy.md @@ -2,9 +2,20 @@ import { Concept } from '@site/src/components/Concept' This is a dummy text for a new mastery concept. -This is a . Then some other thing on the same line. + +This is another dummy definition for a new core concept. +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + + +This is inline, using the component data defined above. +This is a rendered inline from the internal map of stored concepts.

-The block of text below is auto-generated with the same component: - +The blocks of text below are auto-generated with the same components above: + + From f8f7b4f84fcf6fd30e04708b8729db29099d9dc0 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 2 Apr 2024 17:16:09 +0200 Subject: [PATCH 15/33] chg: Apply the Concept component to the typescript concepts partials --- docs/_partials/concepts/typescript/avatars/animations.md | 8 +++++++- .../_partials/concepts/typescript/avatars/description.md | 8 +++++++- docs/_partials/concepts/typescript/avatars/ik.md | 8 +++++++- docs/_partials/concepts/typescript/avatars/mocap.md | 8 +++++++- .../_partials/concepts/typescript/avatars/retargeting.md | 8 +++++++- docs/_partials/concepts/typescript/ecs/components.md | 8 +++++++- docs/_partials/concepts/typescript/ecs/description.md | 8 +++++++- docs/_partials/concepts/typescript/ecs/eventSourcing.md | 8 +++++++- docs/_partials/concepts/typescript/ecs/queries.md | 8 +++++++- .../concepts/typescript/ecs/systems/description.md | 8 +++++++- .../typescript/ecs/systems/executionOrder/description.md | 8 +++++++- .../typescript/ecs/systems/executionOrder/fixedRate.md | 8 +++++++- .../typescript/ecs/systems/executionOrder/visualRate.md | 8 +++++++- docs/_partials/concepts/typescript/inputs/description.md | 8 +++++++- docs/_partials/concepts/typescript/inputs/grabbables.md | 8 +++++++- docs/_partials/concepts/typescript/inputs/interaction.md | 8 +++++++- docs/_partials/concepts/typescript/inputs/spatial.md | 8 +++++++- docs/_partials/concepts/typescript/logicdata.md | 9 +++++++-- docs/_partials/concepts/typescript/mastery/cicd.md | 8 +++++++- docs/_partials/concepts/typescript/mastery/cms/assets.md | 8 +++++++- .../concepts/typescript/mastery/cms/description.md | 8 +++++++- .../concepts/typescript/mastery/cms/projects.md | 8 +++++++- docs/_partials/concepts/typescript/mastery/cms/studio.md | 8 +++++++- .../_partials/concepts/typescript/mastery/description.md | 8 +++++++- .../concepts/typescript/mastery/engine/description.md | 8 +++++++- .../concepts/typescript/mastery/engine/modules.md | 8 +++++++- .../concepts/typescript/mastery/engine/navigation.md | 8 +++++++- docs/_partials/concepts/typescript/mastery/gltf.md | 8 +++++++- docs/_partials/concepts/typescript/mastery/rendering.md | 8 +++++++- docs/_partials/concepts/typescript/mastery/testing.md | 8 +++++++- docs/_partials/concepts/typescript/mastery/webxr.md | 8 +++++++- docs/_partials/concepts/typescript/networking/custom.md | 8 +++++++- .../concepts/typescript/networking/description.md | 8 +++++++- docs/_partials/concepts/typescript/networking/simple.md | 8 +++++++- .../_partials/concepts/typescript/physics/description.md | 8 +++++++- docs/_partials/concepts/typescript/physics/simulation.md | 8 +++++++- docs/_partials/concepts/typescript/physics/triggers.md | 8 +++++++- docs/_partials/concepts/typescript/social/description.md | 8 +++++++- docs/_partials/concepts/typescript/state/description.md | 8 +++++++- docs/_partials/concepts/typescript/state/hyperflux.md | 8 +++++++- docs/_partials/concepts/typescript/state/reactivity.md | 8 +++++++- docs/_partials/concepts/typescript/state/reactors.md | 8 +++++++- docs/_partials/concepts/typescript/xrui/description.md | 8 +++++++- 43 files changed, 301 insertions(+), 44 deletions(-) diff --git a/docs/_partials/concepts/typescript/avatars/animations.md b/docs/_partials/concepts/typescript/avatars/animations.md index fe55fda3ebbc..d911d2a00c38 100644 --- a/docs/_partials/concepts/typescript/avatars/animations.md +++ b/docs/_partials/concepts/typescript/avatars/animations.md @@ -1,2 +1,8 @@ -**Animations**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/avatars/description.md b/docs/_partials/concepts/typescript/avatars/description.md index 7dd72c7b5805..9dd0c2722418 100644 --- a/docs/_partials/concepts/typescript/avatars/description.md +++ b/docs/_partials/concepts/typescript/avatars/description.md @@ -1,3 +1,9 @@ -**Avatars**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/avatars/ik.md b/docs/_partials/concepts/typescript/avatars/ik.md index e6a8ac8bffa1..b36fab6ea045 100644 --- a/docs/_partials/concepts/typescript/avatars/ik.md +++ b/docs/_partials/concepts/typescript/avatars/ik.md @@ -1,3 +1,9 @@ -**Inverse Kinematics**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/avatars/mocap.md b/docs/_partials/concepts/typescript/avatars/mocap.md index 54428ae9b4f1..b2fb953df52b 100644 --- a/docs/_partials/concepts/typescript/avatars/mocap.md +++ b/docs/_partials/concepts/typescript/avatars/mocap.md @@ -1,3 +1,9 @@ -**Motion Capture**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/avatars/retargeting.md b/docs/_partials/concepts/typescript/avatars/retargeting.md index b1ebd47eaf52..e056d01e4da3 100644 --- a/docs/_partials/concepts/typescript/avatars/retargeting.md +++ b/docs/_partials/concepts/typescript/avatars/retargeting.md @@ -1,3 +1,9 @@ -**Retargeting**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/components.md b/docs/_partials/concepts/typescript/ecs/components.md index 69d3e68fa916..1da4d6b1dadc 100644 --- a/docs/_partials/concepts/typescript/ecs/components.md +++ b/docs/_partials/concepts/typescript/ecs/components.md @@ -1,2 +1,8 @@ -**Components**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/description.md b/docs/_partials/concepts/typescript/ecs/description.md index 53b4840e911f..ee96b15e4fac 100644 --- a/docs/_partials/concepts/typescript/ecs/description.md +++ b/docs/_partials/concepts/typescript/ecs/description.md @@ -1,3 +1,9 @@ -**Entity Component System**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/eventSourcing.md b/docs/_partials/concepts/typescript/ecs/eventSourcing.md index aeb0aca4ad9d..eed59f8679f8 100644 --- a/docs/_partials/concepts/typescript/ecs/eventSourcing.md +++ b/docs/_partials/concepts/typescript/ecs/eventSourcing.md @@ -1,3 +1,9 @@ -**Event Sourcing**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/queries.md b/docs/_partials/concepts/typescript/ecs/queries.md index c574acaeed3d..4b5b5d779991 100644 --- a/docs/_partials/concepts/typescript/ecs/queries.md +++ b/docs/_partials/concepts/typescript/ecs/queries.md @@ -1,3 +1,9 @@ -**Queries**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/systems/description.md b/docs/_partials/concepts/typescript/ecs/systems/description.md index e45c1c858680..83d64ae6c98f 100644 --- a/docs/_partials/concepts/typescript/ecs/systems/description.md +++ b/docs/_partials/concepts/typescript/ecs/systems/description.md @@ -1,3 +1,9 @@ -**Systems**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md index a63f197feb4e..ee835e49ad98 100644 --- a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md +++ b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/description.md @@ -1,2 +1,8 @@ -**Execution Order**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md index 4ea9011d993c..5e07d3f7b934 100644 --- a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md +++ b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/fixedRate.md @@ -1,3 +1,9 @@ -**Fixed Rate**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md index 63395c75e7f3..689a2861f900 100644 --- a/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md +++ b/docs/_partials/concepts/typescript/ecs/systems/executionOrder/visualRate.md @@ -1,3 +1,9 @@ -**Visual Rate**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/inputs/description.md b/docs/_partials/concepts/typescript/inputs/description.md index 524196605ab9..7490863898be 100644 --- a/docs/_partials/concepts/typescript/inputs/description.md +++ b/docs/_partials/concepts/typescript/inputs/description.md @@ -1,3 +1,9 @@ -**Inputs System**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/inputs/grabbables.md b/docs/_partials/concepts/typescript/inputs/grabbables.md index a08b42c3e360..deaf7c7a3b98 100644 --- a/docs/_partials/concepts/typescript/inputs/grabbables.md +++ b/docs/_partials/concepts/typescript/inputs/grabbables.md @@ -1,3 +1,9 @@ -**Grabbables**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/inputs/interaction.md b/docs/_partials/concepts/typescript/inputs/interaction.md index 2adf93d7eb0e..e0751b210886 100644 --- a/docs/_partials/concepts/typescript/inputs/interaction.md +++ b/docs/_partials/concepts/typescript/inputs/interaction.md @@ -1,3 +1,9 @@ -**Interaction System**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/inputs/spatial.md b/docs/_partials/concepts/typescript/inputs/spatial.md index 8ef1858aae73..cc9f63db062a 100644 --- a/docs/_partials/concepts/typescript/inputs/spatial.md +++ b/docs/_partials/concepts/typescript/inputs/spatial.md @@ -1,3 +1,9 @@ -**Spatial Inputs**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/logicdata.md b/docs/_partials/concepts/typescript/logicdata.md index 7b9e70ce4ae8..e5d348879a0f 100644 --- a/docs/_partials/concepts/typescript/logicdata.md +++ b/docs/_partials/concepts/typescript/logicdata.md @@ -1,3 +1,8 @@ -**Logic vs Data**: -Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. +import { Concept } from '@site/src/components/Concept' + +Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cicd.md b/docs/_partials/concepts/typescript/mastery/cicd.md index c7e641d673b7..ed11cdd0528d 100644 --- a/docs/_partials/concepts/typescript/mastery/cicd.md +++ b/docs/_partials/concepts/typescript/mastery/cicd.md @@ -1,3 +1,9 @@ -**CI/CD**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cms/assets.md b/docs/_partials/concepts/typescript/mastery/cms/assets.md index 14e4d1aa3e63..b591b30fcc76 100644 --- a/docs/_partials/concepts/typescript/mastery/cms/assets.md +++ b/docs/_partials/concepts/typescript/mastery/cms/assets.md @@ -1,3 +1,9 @@ -**Assets**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cms/description.md b/docs/_partials/concepts/typescript/mastery/cms/description.md index 0af284b8bbc5..e1a96d01abac 100644 --- a/docs/_partials/concepts/typescript/mastery/cms/description.md +++ b/docs/_partials/concepts/typescript/mastery/cms/description.md @@ -1,3 +1,9 @@ -**CMS**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cms/projects.md b/docs/_partials/concepts/typescript/mastery/cms/projects.md index 40e8853a4557..fefcc0f68beb 100644 --- a/docs/_partials/concepts/typescript/mastery/cms/projects.md +++ b/docs/_partials/concepts/typescript/mastery/cms/projects.md @@ -1,3 +1,9 @@ -**Projects**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/cms/studio.md b/docs/_partials/concepts/typescript/mastery/cms/studio.md index 76acd3a338a0..56769d615235 100644 --- a/docs/_partials/concepts/typescript/mastery/cms/studio.md +++ b/docs/_partials/concepts/typescript/mastery/cms/studio.md @@ -1,3 +1,9 @@ -**Studio**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/description.md b/docs/_partials/concepts/typescript/mastery/description.md index 1630c1c82bfd..0d34ab2f0baa 100644 --- a/docs/_partials/concepts/typescript/mastery/description.md +++ b/docs/_partials/concepts/typescript/mastery/description.md @@ -1,3 +1,9 @@ -**Mastery Toolkit**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/engine/description.md b/docs/_partials/concepts/typescript/mastery/engine/description.md index 5613221cbd80..12e9ac523896 100644 --- a/docs/_partials/concepts/typescript/mastery/engine/description.md +++ b/docs/_partials/concepts/typescript/mastery/engine/description.md @@ -1,3 +1,9 @@ -**Engine**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/engine/modules.md b/docs/_partials/concepts/typescript/mastery/engine/modules.md index dad8cf17e49c..1ff05d4416b6 100644 --- a/docs/_partials/concepts/typescript/mastery/engine/modules.md +++ b/docs/_partials/concepts/typescript/mastery/engine/modules.md @@ -1,3 +1,9 @@ -**Modules**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/engine/navigation.md b/docs/_partials/concepts/typescript/mastery/engine/navigation.md index a6afe775fdb0..ddb72ffff2e4 100644 --- a/docs/_partials/concepts/typescript/mastery/engine/navigation.md +++ b/docs/_partials/concepts/typescript/mastery/engine/navigation.md @@ -1,3 +1,9 @@ -**Navigation**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/gltf.md b/docs/_partials/concepts/typescript/mastery/gltf.md index 6c4d72c2a44e..66e2e995ee3c 100644 --- a/docs/_partials/concepts/typescript/mastery/gltf.md +++ b/docs/_partials/concepts/typescript/mastery/gltf.md @@ -1,3 +1,9 @@ -**glTF**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/rendering.md b/docs/_partials/concepts/typescript/mastery/rendering.md index 5bc12e0614d2..a41d812746f6 100644 --- a/docs/_partials/concepts/typescript/mastery/rendering.md +++ b/docs/_partials/concepts/typescript/mastery/rendering.md @@ -1,3 +1,9 @@ -**Rendering**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/testing.md b/docs/_partials/concepts/typescript/mastery/testing.md index 74805f429002..fe3d507ef96b 100644 --- a/docs/_partials/concepts/typescript/mastery/testing.md +++ b/docs/_partials/concepts/typescript/mastery/testing.md @@ -1,3 +1,9 @@ -**Unit Testing**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/mastery/webxr.md b/docs/_partials/concepts/typescript/mastery/webxr.md index b3450ebc1415..b4516cc054a0 100644 --- a/docs/_partials/concepts/typescript/mastery/webxr.md +++ b/docs/_partials/concepts/typescript/mastery/webxr.md @@ -1,3 +1,9 @@ -**WebXR**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/networking/custom.md b/docs/_partials/concepts/typescript/networking/custom.md index 78853af06b0a..9f246721b23c 100644 --- a/docs/_partials/concepts/typescript/networking/custom.md +++ b/docs/_partials/concepts/typescript/networking/custom.md @@ -1,3 +1,9 @@ -**Custom Networking**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/networking/description.md b/docs/_partials/concepts/typescript/networking/description.md index 5c5c54f5daa5..5cacc14c4ce2 100644 --- a/docs/_partials/concepts/typescript/networking/description.md +++ b/docs/_partials/concepts/typescript/networking/description.md @@ -1,3 +1,9 @@ -**Networking**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/networking/simple.md b/docs/_partials/concepts/typescript/networking/simple.md index be7ad847aafe..7271c20efc9a 100644 --- a/docs/_partials/concepts/typescript/networking/simple.md +++ b/docs/_partials/concepts/typescript/networking/simple.md @@ -1,3 +1,9 @@ -**Networking (`spawnEntity()`)**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/physics/description.md b/docs/_partials/concepts/typescript/physics/description.md index 551a64737da3..868bbf21c668 100644 --- a/docs/_partials/concepts/typescript/physics/description.md +++ b/docs/_partials/concepts/typescript/physics/description.md @@ -1,3 +1,9 @@ -**Physics**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/physics/simulation.md b/docs/_partials/concepts/typescript/physics/simulation.md index d801b381a1c8..31ecfd83b120 100644 --- a/docs/_partials/concepts/typescript/physics/simulation.md +++ b/docs/_partials/concepts/typescript/physics/simulation.md @@ -1,3 +1,9 @@ -**Physics Simulation**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/physics/triggers.md b/docs/_partials/concepts/typescript/physics/triggers.md index 1fba423c1fa4..85de29aa09d5 100644 --- a/docs/_partials/concepts/typescript/physics/triggers.md +++ b/docs/_partials/concepts/typescript/physics/triggers.md @@ -1,3 +1,9 @@ -**Triggers**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/social/description.md b/docs/_partials/concepts/typescript/social/description.md index 9c438efddfcc..01925c4d24d4 100644 --- a/docs/_partials/concepts/typescript/social/description.md +++ b/docs/_partials/concepts/typescript/social/description.md @@ -1,3 +1,9 @@ -**Social System**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/state/description.md b/docs/_partials/concepts/typescript/state/description.md index 2ef9bc691041..a3457501956b 100644 --- a/docs/_partials/concepts/typescript/state/description.md +++ b/docs/_partials/concepts/typescript/state/description.md @@ -1,3 +1,9 @@ -**State**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/state/hyperflux.md b/docs/_partials/concepts/typescript/state/hyperflux.md index 66b92b2b775e..f04282851465 100644 --- a/docs/_partials/concepts/typescript/state/hyperflux.md +++ b/docs/_partials/concepts/typescript/state/hyperflux.md @@ -1,3 +1,9 @@ -**Hyperflux**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/state/reactivity.md b/docs/_partials/concepts/typescript/state/reactivity.md index e0097cc91bff..e07066a8464b 100644 --- a/docs/_partials/concepts/typescript/state/reactivity.md +++ b/docs/_partials/concepts/typescript/state/reactivity.md @@ -1,3 +1,9 @@ -**Reactivity**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/state/reactors.md b/docs/_partials/concepts/typescript/state/reactors.md index 0bb320c3497c..39b643cfe528 100644 --- a/docs/_partials/concepts/typescript/state/reactors.md +++ b/docs/_partials/concepts/typescript/state/reactors.md @@ -1,3 +1,9 @@ -**Reactors**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + diff --git a/docs/_partials/concepts/typescript/xrui/description.md b/docs/_partials/concepts/typescript/xrui/description.md index 50f5d435896e..6d5fa3c0d709 100644 --- a/docs/_partials/concepts/typescript/xrui/description.md +++ b/docs/_partials/concepts/typescript/xrui/description.md @@ -1,3 +1,9 @@ -**XRUI**: +import { Concept } from '@site/src/components/Concept' + + Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + From 2d08c1b99fb395d029b55815e1607ff8aa058b87 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 2 Apr 2024 17:49:42 +0200 Subject: [PATCH 16/33] fix: Silence React console error on lowercase component definition --- docs/_partials/concepts/typescript/mastery.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_partials/concepts/typescript/mastery.md b/docs/_partials/concepts/typescript/mastery.md index 4dc5c580d890..7bda1c1f93df 100644 --- a/docs/_partials/concepts/typescript/mastery.md +++ b/docs/_partials/concepts/typescript/mastery.md @@ -2,7 +2,7 @@ import Description from './mastery/description.md' import CICD from './mastery/cicd.md' import CMS from './mastery/cms.md' import Engine from './mastery/engine.md' -import glTF from './mastery/gltf.md' +import GLTF from './mastery/gltf.md' import Rendering from './mastery/rendering.md' import Testing from './mastery/testing.md' import WebXR from './mastery/webxr.md' @@ -11,7 +11,7 @@ import WebXR from './mastery/webxr.md' - + From 0f256e793ab8ff4e428ad92223dfdadc83dcdc27 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 2 Apr 2024 18:02:37 +0200 Subject: [PATCH 17/33] doc: Add instructions for temporary Concepts to the dummy.md file --- docs/_partials/{roadmap => concepts}/dummy.md | 17 +++++++++++++++++ src/components/Concept.tsx | 6 +++--- 2 files changed, 20 insertions(+), 3 deletions(-) rename docs/_partials/{roadmap => concepts}/dummy.md (51%) diff --git a/docs/_partials/roadmap/dummy.md b/docs/_partials/concepts/dummy.md similarity index 51% rename from docs/_partials/roadmap/dummy.md rename to docs/_partials/concepts/dummy.md index 2989fb947f8b..f1cc0f5ca8f9 100644 --- a/docs/_partials/roadmap/dummy.md +++ b/docs/_partials/concepts/dummy.md @@ -10,6 +10,7 @@ This is another dummy definition for a new core concept. Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat. + This is inline, using the component data defined above. This is a rendered inline from the internal map of stored concepts. @@ -19,3 +20,19 @@ The blocks of text below are auto-generated with the same components above: +

+ +This is a temporary Concept definition. +Its data will not be stored in the internal list of concepts. +This means that this concept cannot be rendered just by calling its title, like we did with the examples above. +Concept titles are used to search for the Concept inside the internal list of previously defined concepts, but temporary concepts do not exist in that list. + + + diff --git a/src/components/Concept.tsx b/src/components/Concept.tsx index 215b43418bc8..4f88f5885d1e 100644 --- a/src/components/Concept.tsx +++ b/src/components/Concept.tsx @@ -186,9 +186,9 @@ const UnknownConcept = (props) => { */ const KnownConcept = (props) => { // Replace with text from the ConceptList, based on the passed `title=` value - // TODO : FIXME: Massive hack. - // : How to access Map fields by a string? - // : They don't work for some reason :thinking: + // FIXME : Massive hack. + // : How to access Map fields by a string? + // : They don't work for some reason :thinking: // const Title = ConceptList[props.title].Title // const Kind = ConceptList[props.title].kind // const Category = ConceptList[props.title].category From 4aea632241c82edce751c819ab92691e1a78c6f1 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 2 Apr 2024 18:07:25 +0200 Subject: [PATCH 18/33] fix: Remove extra linebreak at the end of each block block render --- src/components/Concept.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/Concept.tsx b/src/components/Concept.tsx index 4f88f5885d1e..a75b65a8542f 100644 --- a/src/components/Concept.tsx +++ b/src/components/Concept.tsx @@ -149,7 +149,7 @@ const ConceptBlock = (props) => {
{props.title}{AfterTitle}
{props.children} -

+ ) } From e146d17895685129ed6bb4cd9c75e518854fb8a4 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 2 Apr 2024 20:24:14 +0200 Subject: [PATCH 19/33] chg: Better block Concept rendering --- src/components/Concept.tsx | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/src/components/Concept.tsx b/src/components/Concept.tsx index a75b65a8542f..4e54bf2a7090 100644 --- a/src/components/Concept.tsx +++ b/src/components/Concept.tsx @@ -77,6 +77,13 @@ export function addConcept( ConceptList.set(title, data) } +/* + * @internal + * @description Returns the correct text for marking a Concept as essential or Non-Essential, based on the given {@param kind} + */ +function getEssentialText(kind :ConceptKind) { + return kind == ConceptKind.core ? "Essential" : (kind == ConceptKind.advanced) ? "Non-Essential" : ""; +} /* * @internal @@ -99,7 +106,7 @@ const ConceptInlineTooltip = (props) => { // Description style const Description = "text-justify" // Figure out if the concept is essential or not, and add the text to the Top Section - const essentialText = props.kind == ConceptKind.core ? "Essential" : (props.kind == ConceptKind.advanced) ? "Non-Essential" : ""; + const essentialText = getEssentialText(props.kind) // Render the Component return (
@@ -108,7 +115,7 @@ const ConceptInlineTooltip = (props) => { {essentialText} Type: {props.category} {props.kind} Concept
- {props.children} + {props.children} {/* Description */} ); } @@ -128,7 +135,7 @@ const ConceptInline = (props) => { kind = {props.kind} category = {props.category} > - {props.children} + {props.children} {/* Description */} ); @@ -142,13 +149,18 @@ const ConceptBlock = (props) => { // Text Content const AfterTitle = ": " // CSS - const Title = "font-bold" const Container = "" + const Title = "" + const Meta = "right-80 text-align-right text-sm" + const Essential = "italic text-xs" + // Figure out if the concept is essential or not, and add the text to the Top Section + const essentialText = getEssentialText(props.kind) // Return the component HTML Fragment return (
- {props.title}{AfterTitle}
- {props.children} + {props.title}{AfterTitle} +   {props.kind} {essentialText} + {props.children} {/* Description */}
) } @@ -171,11 +183,11 @@ const ConceptSelector = (props) => { */ const UnknownConcept = (props) => { // Replace with Dummy text when omitted - const Title = props.title ? props.title : Dummy.title - const Kind = props.kind ? props.kind : Dummy.kind + const Title = props.title ? props.title : Dummy.title + const Kind = props.kind ? props.kind : Dummy.kind const Category = props.category ? props.category : Dummy.category const Body = props.children ? props.children : Dummy.description - // Store the concept into `ConceptList` when it hasn't been yet, and `temporar=` is not set to true + // Store the concept into `ConceptList` when it hasn't been yet, and `temporary=` is not set to true if (!props.temporary && !ConceptList.has(Title)) addConcept(Title, Kind, Category, Body) // Return the component HTML Fragment return ({Body}) @@ -236,7 +248,7 @@ export const Concept = (props) => { block = {props.block} temporary = {props.temporary} > - {props.children} + {props.children} {/* Description */} ); } From 8b38c469df08e5b80f429f1e8ab1286ea2735460 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Tue, 2 Apr 2024 21:49:11 +0200 Subject: [PATCH 20/33] doc: Visualscript+Creator concepts list sketch (todo) --- docs/_partials/concepts/creator.md | 123 ++++++++++++++++++++++++ docs/_partials/concepts/visualscript.md | 80 +++++++++++++++ 2 files changed, 203 insertions(+) diff --git a/docs/_partials/concepts/creator.md b/docs/_partials/concepts/creator.md index 5007707de851..450bbb6f208a 100644 --- a/docs/_partials/concepts/creator.md +++ b/docs/_partials/concepts/creator.md @@ -7,3 +7,126 @@ import Concept1 from '@site/docs/_partials/concepts/creator/concept1.md' + + diff --git a/docs/_partials/concepts/visualscript.md b/docs/_partials/concepts/visualscript.md index 323857667d3a..83ab94a20b4e 100644 --- a/docs/_partials/concepts/visualscript.md +++ b/docs/_partials/concepts/visualscript.md @@ -7,3 +7,83 @@ import Concept1 from '@site/docs/_partials/concepts/visualscript/concept1.md' + + From 74ea758358d2b0973c450b4c10337d9a0cb8f7d9 Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Thu, 4 Apr 2024 20:46:40 +0200 Subject: [PATCH 21/33] fmt: Rename concepts/dummy.md to concepts/example.md --- docs/_partials/concepts/{dummy.md => example.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/_partials/concepts/{dummy.md => example.md} (100%) diff --git a/docs/_partials/concepts/dummy.md b/docs/_partials/concepts/example.md similarity index 100% rename from docs/_partials/concepts/dummy.md rename to docs/_partials/concepts/example.md From 6ce49624af79bd3140f13572aad18f7db215d58a Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Thu, 4 Apr 2024 20:46:58 +0200 Subject: [PATCH 22/33] new: Visualscript concepts folder structure --- docs/_partials/concepts/visualscript.md | 26 +++++++++++++++++++ .../concepts/visualscript/bestPractices.md | 2 ++ .../concepts/visualscript/customNodes.md | 3 +++ .../visualscript/customNodes/description.md | 2 ++ .../concepts/visualscript/dataType.md | 26 +++++++++++++++++++ .../concepts/visualscript/dataType/bool.md | 1 + .../visualscript/dataType/description.md | 2 ++ .../concepts/visualscript/dataType/entity.md | 2 ++ .../concepts/visualscript/dataType/euler.md | 2 ++ .../concepts/visualscript/dataType/float.md | 2 ++ .../concepts/visualscript/dataType/integer.md | 2 ++ .../concepts/visualscript/dataType/list.md | 2 ++ .../concepts/visualscript/dataType/matrix.md | 2 ++ .../concepts/visualscript/dataType/object.md | 2 ++ .../visualscript/dataType/quaternion.md | 2 ++ .../concepts/visualscript/dataType/string.md | 2 ++ .../concepts/visualscript/dataType/vector.md | 2 ++ docs/_partials/concepts/visualscript/edges.md | 7 +++++ .../visualscript/edges/description.md | 2 ++ .../concepts/visualscript/edges/flow.md | 5 ++++ .../concepts/visualscript/edges/flow/input.md | 2 ++ .../visualscript/edges/flow/output.md | 2 ++ .../concepts/visualscript/edges/value.md | 6 +++++ .../visualscript/edges/value/input.md | 2 ++ .../visualscript/edges/value/output.md | 2 ++ docs/_partials/concepts/visualscript/node.md | 7 +++++ .../concepts/visualscript/node/description.md | 2 ++ .../concepts/visualscript/node/essential.md | 13 ++++++++++ .../visualscript/node/essential/action.md | 6 +++++ .../node/essential/action/consumer.md | 2 ++ .../node/essential/action/dispatcher.md | 2 ++ .../visualscript/node/essential/component.md | 9 +++++++ .../node/essential/component/get.md | 2 ++ .../node/essential/component/listen.md | 2 ++ .../node/essential/component/set.md | 2 ++ .../node/essential/component/use.md | 2 ++ .../node/essential/description.md | 2 ++ .../visualscript/node/essential/event.md | 5 ++++ .../node/essential/event/onExecute.md | 2 ++ .../node/essential/event/onStart.md | 2 ++ .../visualscript/node/essential/flow.md | 3 +++ .../node/essential/flow/debugLog.md | 2 ++ .../visualscript/node/essential/state.md | 10 +++++++ .../visualscript/node/essential/state/get.md | 2 ++ .../node/essential/state/listen.md | 2 ++ .../visualscript/node/essential/state/set.md | 2 ++ .../visualscript/node/essential/state/use.md | 2 ++ .../concepts/visualscript/node/types.md | 14 ++++++++++ .../concepts/visualscript/node/types/async.md | 2 ++ .../visualscript/node/types/description.md | 2 ++ .../concepts/visualscript/node/types/event.md | 2 ++ .../concepts/visualscript/node/types/flow.md | 2 ++ .../visualscript/node/types/function.md | 2 ++ .../concepts/visualscript/node/types/time.md | 2 ++ .../concepts/visualscript/profiles.md | 3 +++ .../concepts/visualscript/profiles/core.md | 2 ++ .../visualscript/profiles/description.md | 2 ++ .../concepts/visualscript/profiles/engine.md | 2 ++ .../concepts/visualscript/profiles/scene.md | 2 ++ .../concepts/visualscript/profiles/struct.md | 2 ++ .../_partials/concepts/visualscript/script.md | 7 +++++ .../visualscript/script/description.md | 2 ++ .../concepts/visualscript/script/headful.md | 2 ++ .../concepts/visualscript/script/headless.md | 2 ++ .../concepts/visualscript/templates.md | 3 +++ .../visualscript/templates/description.md | 2 ++ docs/_partials/concepts/visualscript/ui.md | 9 +++++++ .../concepts/visualscript/ui/editor.md | 2 ++ .../concepts/visualscript/ui/picker.md | 2 ++ .../concepts/visualscript/ui/utility.md | 2 ++ .../concepts/visualscript/ui/workspace.md | 2 ++ .../concepts/visualscript/variables.md | 9 +++++++ .../visualscript/variables/description.md | 2 ++ .../concepts/visualscript/variables/getter.md | 2 ++ .../visualscript/variables/listener.md | 2 ++ .../concepts/visualscript/variables/setter.md | 2 ++ 76 files changed, 284 insertions(+) create mode 100644 docs/_partials/concepts/visualscript/bestPractices.md create mode 100644 docs/_partials/concepts/visualscript/customNodes.md create mode 100644 docs/_partials/concepts/visualscript/customNodes/description.md create mode 100644 docs/_partials/concepts/visualscript/dataType.md create mode 100644 docs/_partials/concepts/visualscript/dataType/bool.md create mode 100644 docs/_partials/concepts/visualscript/dataType/description.md create mode 100644 docs/_partials/concepts/visualscript/dataType/entity.md create mode 100644 docs/_partials/concepts/visualscript/dataType/euler.md create mode 100644 docs/_partials/concepts/visualscript/dataType/float.md create mode 100644 docs/_partials/concepts/visualscript/dataType/integer.md create mode 100644 docs/_partials/concepts/visualscript/dataType/list.md create mode 100644 docs/_partials/concepts/visualscript/dataType/matrix.md create mode 100644 docs/_partials/concepts/visualscript/dataType/object.md create mode 100644 docs/_partials/concepts/visualscript/dataType/quaternion.md create mode 100644 docs/_partials/concepts/visualscript/dataType/string.md create mode 100644 docs/_partials/concepts/visualscript/dataType/vector.md create mode 100644 docs/_partials/concepts/visualscript/edges.md create mode 100644 docs/_partials/concepts/visualscript/edges/description.md create mode 100644 docs/_partials/concepts/visualscript/edges/flow.md create mode 100644 docs/_partials/concepts/visualscript/edges/flow/input.md create mode 100644 docs/_partials/concepts/visualscript/edges/flow/output.md create mode 100644 docs/_partials/concepts/visualscript/edges/value.md create mode 100644 docs/_partials/concepts/visualscript/edges/value/input.md create mode 100644 docs/_partials/concepts/visualscript/edges/value/output.md create mode 100644 docs/_partials/concepts/visualscript/node.md create mode 100644 docs/_partials/concepts/visualscript/node/description.md create mode 100644 docs/_partials/concepts/visualscript/node/essential.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/action.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/action/consumer.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/action/dispatcher.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/component.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/component/get.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/component/listen.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/component/set.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/component/use.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/description.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/event.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/event/onExecute.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/event/onStart.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/flow.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/flow/debugLog.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/state.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/state/get.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/state/listen.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/state/set.md create mode 100644 docs/_partials/concepts/visualscript/node/essential/state/use.md create mode 100644 docs/_partials/concepts/visualscript/node/types.md create mode 100644 docs/_partials/concepts/visualscript/node/types/async.md create mode 100644 docs/_partials/concepts/visualscript/node/types/description.md create mode 100644 docs/_partials/concepts/visualscript/node/types/event.md create mode 100644 docs/_partials/concepts/visualscript/node/types/flow.md create mode 100644 docs/_partials/concepts/visualscript/node/types/function.md create mode 100644 docs/_partials/concepts/visualscript/node/types/time.md create mode 100644 docs/_partials/concepts/visualscript/profiles.md create mode 100644 docs/_partials/concepts/visualscript/profiles/core.md create mode 100644 docs/_partials/concepts/visualscript/profiles/description.md create mode 100644 docs/_partials/concepts/visualscript/profiles/engine.md create mode 100644 docs/_partials/concepts/visualscript/profiles/scene.md create mode 100644 docs/_partials/concepts/visualscript/profiles/struct.md create mode 100644 docs/_partials/concepts/visualscript/script.md create mode 100644 docs/_partials/concepts/visualscript/script/description.md create mode 100644 docs/_partials/concepts/visualscript/script/headful.md create mode 100644 docs/_partials/concepts/visualscript/script/headless.md create mode 100644 docs/_partials/concepts/visualscript/templates.md create mode 100644 docs/_partials/concepts/visualscript/templates/description.md create mode 100644 docs/_partials/concepts/visualscript/ui.md create mode 100644 docs/_partials/concepts/visualscript/ui/editor.md create mode 100644 docs/_partials/concepts/visualscript/ui/picker.md create mode 100644 docs/_partials/concepts/visualscript/ui/utility.md create mode 100644 docs/_partials/concepts/visualscript/ui/workspace.md create mode 100644 docs/_partials/concepts/visualscript/variables.md create mode 100644 docs/_partials/concepts/visualscript/variables/description.md create mode 100644 docs/_partials/concepts/visualscript/variables/getter.md create mode 100644 docs/_partials/concepts/visualscript/variables/listener.md create mode 100644 docs/_partials/concepts/visualscript/variables/setter.md diff --git a/docs/_partials/concepts/visualscript.md b/docs/_partials/concepts/visualscript.md index 83ab94a20b4e..5bfc1b99574e 100644 --- a/docs/_partials/concepts/visualscript.md +++ b/docs/_partials/concepts/visualscript.md @@ -1,6 +1,32 @@ +import UI from '@site/docs/_partials/concepts/visualscript/ui.md' +import Script from '@site/docs/_partials/concepts/visualscript/script.md' +import Node from '@site/docs/_partials/concepts/visualscript/node.md' +import Edges from '@site/docs/_partials/concepts/visualscript/edges.md' +import DataType from '@site/docs/_partials/concepts/visualscript/dataType.md' +import BestPractices from '@site/docs/_partials/concepts/visualscript/bestPractices.md' +import Variables from '@site/docs/_partials/concepts/visualscript/variables.md' +import Templates from '@site/docs/_partials/concepts/visualscript/templates.md' +import Profiles from '@site/docs/_partials/concepts/visualscript/profiles.md' +import CustomNodes from '@site/docs/_partials/concepts/visualscript/customNodes.md' import Concept1 from '@site/docs/_partials/concepts/visualscript/concept1.md' + + + +