ir-engine · heysokam · Apr 15, 2024 · Mar 26, 2024 · Mar 26, 2024 · Mar 26, 2024
diff --git a/docs/_partials/community/assets.md b/docs/_partials/community/assets.md
@@ -0,0 +1,4 @@
+<!--
+## Community Assets
+This section will contain a list of third-party assets created by the community.
+-->
diff --git a/docs/_partials/community/channels.md b/docs/_partials/community/channels.md
@@ -0,0 +1,15 @@
+<!--
+## Community channels
+- [Twitter](https://twitter.com/xr_engine)
+- [Facebook](https://www.facebook.com/xrengine/)
+- [Discord](https://discord.gg/xrf)
+-->
+
+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
@@ -0,0 +1,3 @@
+<!--
+TODO
+-->
diff --git a/docs/_partials/community/tutorials.md b/docs/_partials/community/tutorials.md
@@ -0,0 +1,4 @@
+<!--
+## Community Tutorials
+This section will contain a list of third-party tutorials and resources created by the community.
+-->
diff --git a/docs/_partials/concepts/creator/concept1.md 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
@@ -0,0 +1 @@
+Concept1
diff --git a/docs/_partials/concepts/typescript/concept1.md 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
@@ -0,0 +1 @@
+Concept1
diff --git a/docs/_partials/contributing/develop.md 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
@@ -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
@@ -0,0 +1,3 @@
+<!--
+TODO
+-->
diff --git a/docs/_partials/contributing/host.md 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.
+<!-- TODO: Revise the copywriting of this paragraph after the `Promote Ethereal Engine` copy has been revised, so that it segues better into the next section. -->
diff --git a/docs/_partials/contributing/intro.md b/docs/_partials/contributing/intro.md
@@ -0,0 +1,3 @@
+<!--
+TODO
+-->
diff --git a/docs/_partials/contributing/participate.md 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
@@ -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.  
+<!-- TODO: Improve the copywriting quality of this paragraph with better marketing information, based on Ethereal's marketing strategy. -->
diff --git a/docs/_partials/contributing/test.md 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
@@ -0,0 +1,3 @@
+<!--
+TODO
+-->
diff --git a/docs/_partials/host/intro.md b/docs/_partials/host/intro.md
@@ -0,0 +1,3 @@
+<!--
+TODO
+-->
diff --git a/docs/_partials/license.md 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/creator/01_gettingStarted/01_quickstart.md b/docs/creator/01_gettingStarted/01_quickstart.md
@@ -0,0 +1,8 @@
+---
+draft: true
+---
+
+# QuickStart
+<!--
+TODO
+-->
diff --git a/docs/creator/01_gettingStarted/02_hello/_category_.yml 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
@@ -0,0 +1,9 @@
+---
+draft: true
+title: Hello Tree
+---
+
+# Hello World
+<!--
+TODO
+-->
diff --git a/docs/creator/01_gettingStarted/index.md b/docs/creator/01_gettingStarted/index.md
@@ -4,9 +4,5 @@ draft: true
 
 # Getting Started
 <!--
-NOTE: This page should contain:
-- Hero Project: Showcase for Ethereal Engine's content creation tools and workflows.
-- Guide: Teaches a new user how to create and be comfortable with the Hero Project.
+TODO
 -->
-_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 → docs/creator/02_basics/01_file.md b/docs/creator/01_gettingStarted/01_file.md → docs/creator/02_basics/01_file.md
diff --git a/docs/creator/01_gettingStarted/02_file2.md → docs/creator/02_basics/02_file2.md b/docs/creator/01_gettingStarted/02_file2.md → 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
@@ -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
@@ -0,0 +1,13 @@
+---
+draft: true
+---
+
+# Hero Project
+<!--
+NOTE: This page should contain:
+- Hero Project: Showcase for Ethereal Engine's development tools and workflows
+- Guide: Expands on the Basics tutorial, and teaches the user how to program the Hero Project and be comfortable with EE project development
+- Segue: Lead the user into the Beyond The Basics guide
+
+TODO:
+-->
diff --git a/docs/creator/02_basics/_category_.yml 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
@@ -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.  
+<!--
+NOTE: This section should contain:
+- Guide: Teaches a new user how to program the Hero Project and be comfortable with EE project development.
+- Hero Project: Showcase for Ethereal Engine's development tools and workflows.
+-->
+
+<DocCardList />
diff --git a/docs/creator/02_topic1/01_file.md → docs/creator/03_beyondBasics/01_file.md b/docs/creator/02_topic1/01_file.md → docs/creator/03_beyondBasics/01_file.md
diff --git a/docs/creator/02_topic1/02_file2.md → docs/creator/03_beyondBasics/02_file2.md b/docs/creator/02_topic1/02_file2.md → docs/creator/03_beyondBasics/02_file2.md
diff --git a/docs/creator/03_beyondBasics/_category_.yml b/docs/creator/03_beyondBasics/_category_.yml
@@ -0,0 +1 @@
+position: 03
diff --git a/docs/creator/02_topic1/index.md → docs/creator/03_beyondBasics/index.md b/docs/creator/02_topic1/index.md → 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 → docs/creator/60_mastery/01_file.md b/docs/creator/03_topic2/01_file.md → docs/creator/60_mastery/01_file.md
diff --git a/docs/creator/03_topic2/02_file2.md → docs/creator/60_mastery/02_file2.md b/docs/creator/03_topic2/02_file2.md → docs/creator/60_mastery/02_file2.md
diff --git a/docs/creator/60_mastery/_category_.yml 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
@@ -0,0 +1,15 @@
+---
+draft: true
+---
+
+import DocCardList from '@theme/DocCardList';
+
+# Mastery Toolkit
+<!--
+TODO:
+Topics to prepare the person to be on their own
+Up until this section, the reader has been relying on Guided Learning.
+This section's goal is to give autonomy to the reader.
+-->
+
+<DocCardList />
diff --git a/docs/creator/98_tutorials/01_unity_bridge.md → docs/creator/96_tutorials/01_unity_bridge.md b/docs/creator/98_tutorials/01_unity_bridge.md → docs/creator/96_tutorials/01_unity_bridge.md
diff --git a/.../creator/98_tutorials/02_unreal_bridge.md → .../creator/96_tutorials/02_unreal_bridge.md b/.../creator/98_tutorials/02_unreal_bridge.md → .../creator/96_tutorials/02_unreal_bridge.md
diff --git a/docs/creator/98_tutorials/_category_.yml → docs/creator/96_tutorials/_category_.yml b/docs/creator/98_tutorials/_category_.yml → docs/creator/96_tutorials/_category_.yml
diff --git a/docs/creator/97_host/_category_.yml 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
@@ -0,0 +1,8 @@
+---
+draft: true
+---
+import Intro from '@site/docs/_partials/host/intro.md'
+
+# Host your own World
+<Intro />
+
diff --git a/docs/creator/98_contribute/_category_.yml 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
@@ -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
+<Intro />
+
+## Participate in the community
+<Participate />
+
+## Create and Host your own worlds
+<Host />
+
+## Promote Ethereal Engine
+<Promote />
+
+## Testing and reporting issues
+<Test />
+
+## Contribute to Ethereal Engine's documentation
+<Documentation />
+
+## Translate Ethereal Engine
+<Translate />
+
+<!--
+TODO
+## Donate to Ethereal Engine
+-->
diff --git a/docs/creator/99_community/_category_.yml 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
@@ -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
+<!--
+TODO: Divide the page into sections when they become relevant in the futures
+## Community Channels
+## Community Tutorials
+## Community Assets
+-->
+
+<CommunityIntro />
+
+<!------------------------------------------->
+<!-- current : Community channels          -->
+<!------------------------------------------->
+
+<CommunityChannels />
+
+
+<!------------------------------------------->
+<!-- future : Community content and assets -->
+<!------------------------------------------->
+<CommunityAssets />
+<CommunityTutorials />
+
diff --git 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
 <!-- TODO: This page will contain an Introduction to the Creator Learning Site. -->
diff --git a/docs/developer/typescript/97_host/_category_.yml 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
@@ -0,0 +1,8 @@
+---
+draft: true
+---
+import Intro from '@site/docs/_partials/host/intro.md'
+
+# Host your own World
+<Intro />
+
diff --git a/docs/developer/typescript/98_contributing/_category_.yml 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
@@ -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
+<Intro />
+
+## Participate in the community
+<Participate />
+
+## Create and Host your own worlds
+<Host />
+
+## Promote Ethereal Engine
+<Promote />
+
+## Contribute to Ethereal Engine's development
+<Develop />
+
+## Testing and reporting issues
+<Test />
+
+## Contribute to Ethereal Engine's documentation
+<Documentation />
+
+## Translate Ethereal Engine
+<Translate />
+
+<!--
+TODO
+## Donate to Ethereal Engine
+-->
+
diff --git a/docs/developer/typescript/99_community/_category_.yml 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
@@ -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
+<!--
+TODO: Divide the page into sections when they become relevant in the futures
+## Community Channels
+## Community Tutorials
+## Community Assets
+-->
+
+<CommunityIntro />
+
+<!------------------------------------------->
+<!-- current : Community channels          -->
+<!------------------------------------------->
+
+<CommunityChannels />
+
+
+<!------------------------------------------->
+<!-- future : Community content and assets -->
+<!------------------------------------------->
+<CommunityAssets />
+<CommunityTutorials />
+
diff --git 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.
 <!--
 TODO:

diff --git a/docs/developer/visualscript/01_gettingStarted/01_quickstart.md b/docs/developer/visualscript/01_gettingStarted/01_quickstart.md
@@ -0,0 +1,8 @@
+---
+draft: true
+---
+
+# QuickStart
+<!--
+TODO
+-->
diff --git a/docs/developer/visualscript/01_gettingStarted/02_hello/_category_.yml 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
@@ -0,0 +1,9 @@
+---
+draft: true
+title: Hello Visualscript
+---
+
+# Hello World
+<!--
+TODO
+-->
diff --git a/docs/developer/visualscript/01_gettingStarted/_category_.yml b/docs/developer/visualscript/01_gettingStarted/_category_.yml
@@ -1 +1 @@
-position: 1
+position: 01
-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    <!--
+    TODO
+    -->
Original file line number	Diff line number	Diff line change
		@@ -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.
Original file line number	Diff line number	Diff line change
		@@ -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.
		<!-- TODO: Improve the copywriting quality of this paragraph with better marketing information, based on Ethereal's marketing strategy. -->