Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[all] Add a new Concept component, and implement the partials folder structure for roadmap+concepts #156

Merged
merged 36 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
7b6290f
new: `Creator` & `Visualscript` Meta-Structure folder skeleton
heysokam Mar 26, 2024
0e95d43
new: Add Contribute+Community sections as Partials to all Microsites
heysokam Mar 26, 2024
2e7fb6d
chg: Read manual/contributing and community content from partials
heysokam Mar 26, 2024
5d25994
new: Concepts and Hosting partials sketch
heysokam Mar 26, 2024
9af3d84
new: `Host your own World` section for the learning microsites
heysokam Mar 26, 2024
b14f962
new: Create the Roadmap introduction content (using _partials)
heysokam Mar 29, 2024
c8a8f7b
new: Typescript Roadmap temporary mockup
heysokam Mar 29, 2024
274592d
new: Visualscript Roadmap temporary mockup
heysokam Mar 29, 2024
fd8fa11
new: Creator Roadmap temporary mockup
heysokam Mar 29, 2024
a7144ef
new: Typescript Concepts full folder structure
heysokam Mar 29, 2024
3e756bf
new: Mockup definitions for all Typescript concepts
heysokam Mar 29, 2024
e3a0c35
rmv: Concepts1 mockup file
heysokam Mar 29, 2024
88da170
new: Concepts Component. Internal database + hover + block generator
heysokam Mar 30, 2024
1d09989
doc: Improve the Concept component usage example in the dummy.md file
heysokam Apr 2, 2024
f8f7b4f
chg: Apply the Concept component to the typescript concepts partials
heysokam Apr 2, 2024
2d08c1b
fix: Silence React console error on lowercase component definition
heysokam Apr 2, 2024
0f256e7
doc: Add instructions for temporary Concepts to the dummy.md file
heysokam Apr 2, 2024
4aea632
fix: Remove extra linebreak at the end of each block block render
heysokam Apr 2, 2024
e146d17
chg: Better block Concept rendering
heysokam Apr 2, 2024
8b38c46
doc: Visualscript+Creator concepts list sketch (todo)
heysokam Apr 2, 2024
74ea758
fmt: Rename concepts/dummy.md to concepts/example.md
heysokam Apr 4, 2024
6ce4962
new: Visualscript concepts folder structure
heysokam Apr 4, 2024
1f7012b
new: Creator concepts structure (phase0)
heysokam Apr 5, 2024
52b97dc
new: Creator concepts structure (phase1)
heysokam Apr 10, 2024
bf3ff7b
fmt: Remove temporary Concept1 renders from concepts/visualscript.md
heysokam Apr 10, 2024
b698905
rmv: Temporary `Concept1` from visualscript partials folder
heysokam Apr 11, 2024
433fc42
new: Add `<Concept ... />` components for every creator concept
heysokam Apr 11, 2024
3e694c8
new: Add `<Concept ... />` components for every visualscript concept
heysokam Apr 11, 2024
577cb52
Merge branch 'main' into new-ConceptsPartials
heysokam Apr 11, 2024
08842b0
fix: Concept component error messages now work properly
heysokam Apr 11, 2024
d4ad118
chg: Concept Tooltip adjusts CSS styling based on reading text size
heysokam Apr 11, 2024
8b7cfcf
fmt: Adjusted `props` access formatting
heysokam Apr 11, 2024
d26e3da
Merge branch 'main' into new-ConceptsPartials
heysokam Apr 15, 2024
04b3513
Merge branch 'main' into new-ConceptsPartials
heysokam Apr 15, 2024
a045367
fix: Concept props (`.kind=`, etc) throw their dupl error incorrectly
heysokam Apr 15, 2024
47102ac
chg: Added path definition reference to all Typescript Concepts
heysokam Apr 15, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions docs/_partials/concepts/creator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
import Dashboard from '@site/docs/_partials/concepts/creator/dashboard.md'
import Studio from '@site/docs/_partials/concepts/creator/studio.md'
import Assets from '@site/docs/_partials/concepts/creator/assets.md'
import Components from '@site/docs/_partials/concepts/creator/components.md'
import Avatars from '@site/docs/_partials/concepts/creator/avatars.md'
import Mastery from '@site/docs/_partials/concepts/creator/mastery.md'

<!-- core -->
<Dashboard />

<!-- core and advanced -->
<Studio />
<Assets />

<!-- advanced only -->
<Components />
<Avatars />

<!-- mastery -->
<Mastery />




<!-- Concepts List (isolated from guided steps)
# Core
## Dashboard -> (new)
Project Management
Installing Projects
Scene Management
Admin Panel
Tutorial Tracks
## Studio
### Material Editor
(viewer+editor)


## Assets
Prefabs
Kits
Lights
LookDev Presets (name TBD)
### Scripts
- [ ] Animation Triggers
- [ ] (tut step) Move object
- [ ] (tut step) Scale object
- [ ] (tut step) Change color
- [ ] (not yet) Animation Timeline
- [ ] Keying
- [ ] URL redirect
- [ ] Ecommerce
### Lighting / Look Dev
Environment Map
Environment Map Baker
Lightmaps
Lightmaps Baker

### CMS
User Library
Assets Packs (Starter Packs/kits)
Assets Panel
Assets Panel Search
Assets Panel Categories
### Scene
Scene Building
Ground Plane
#### Skybox
Cubemap
Time of Day (Procedural)
### Optimization
On Import
On Publish
Compression
Dynamic Loading
Variants & LODs


# Advanced
## Studio
- [ ] Snapping
- [ ] Non-default UI layout
- [ ] Gizmos
- [ ] Switch origin
- [ ] Switch obj reference space
- [ ] Validation/Debug
- [ ] Tilde menu
- [ ] How to use stats
- [ ] Upper limits of drawcalls
- [ ] Upper limits of triangles
- [ ] What are drawcalls/etc
- [ ] Budgets: Not go over the limits, what are they
- [ ] Debug helpers
- [ ] Physics helpers
- ...
- [ ] Graphics Basics: Glossary and gamedev concepts

## Assets
- [ ] Budgets
- [ ] Optimization
- [ ] Variants & LODs
- [ ] Dynamic Loading
- [ ] Compression
### Web Formats
- [ ] ee.GLTF + Extensions
- [ ] Hierarchy
- [ ] Model components
- [ ] gltf vs glb
- [ ] KTX
- [ ] UVOL
- [ ] Streaming (Video/Audio)
### Important Components
- [ ] Text
- [ ] Camera
- [ ] Animations
#### Model Component
- [ ] Animations
- [ ] Custom Materials (Editing, Setting them up)
#### Transform Component
Origin Point

## Avatars
- [ ] Emotes
- [ ] Mocap
- [ ] Custom Avatars (currently hardcoded)


# Mastery
Project Management
- [ ] GitHub Docs
- [ ] Team sync tools
Model Checkers (websites)
Visualscript
GLTF hierarchies (maybe: relationship to USD)
-->
25 changes: 25 additions & 0 deletions docs/_partials/concepts/creator/assets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import Description from '@site/docs/_partials/concepts/creator/assets/description.md'
import Prefabs from '@site/docs/_partials/concepts/creator/assets/prefabs.md'
import Kits from '@site/docs/_partials/concepts/creator/assets/kits.md'
import Lights from '@site/docs/_partials/concepts/creator/assets/lights.md'
import LookDevPresets from '@site/docs/_partials/concepts/creator/assets/lookdev.md'
import Scripts from '@site/docs/_partials/concepts/creator/assets/scripts.md'
import CMS from '@site/docs/_partials/concepts/creator/assets/cms.md'
import Scene from '@site/docs/_partials/concepts/creator/assets/scene.md'
import Skybox from '@site/docs/_partials/concepts/creator/assets/skybox.md'
import Optimization from '@site/docs/_partials/concepts/creator/assets/optimization.md'
import WebFormats from '@site/docs/_partials/concepts/creator/assets/webFormats.md'

<Description />
<Prefabs />
<Kits />
<Lights />
<LookDevPresets />
<Scripts />
<CMS />
<Scene />
<Skybox />

<!-- advanced -->
<Optimization />
<WebFormats />
7 changes: 7 additions & 0 deletions docs/_partials/concepts/creator/assets/cms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import Description from '@site/docs/_partials/concepts/creator/assets/cms/description.md'
import Panel from '@site/docs/_partials/concepts/creator/assets/cms/panel.md'
import Packs from '@site/docs/_partials/concepts/creator/assets/cms/packs.md'

<Description />
<Panel />
<Packs />
11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/cms/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/cms/description"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/cms/description.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/cms/packs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/cms/packs"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/cms/packs.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

7 changes: 7 additions & 0 deletions docs/_partials/concepts/creator/assets/cms/panel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import Description from '@site/docs/_partials/concepts/creator/assets/cms/panel/description.md'
import Search from '@site/docs/_partials/concepts/creator/assets/cms/panel/search.md'
import Categories from '@site/docs/_partials/concepts/creator/assets/cms/panel/categories.md'

<Description />
<Search />
<Categories />
11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/cms/panel/categories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/cms/panel/categories"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/cms/panel/categories.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/cms/panel/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/cms/panel/description"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/cms/panel/description.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/cms/panel/search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/cms/panel/search"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/cms/panel/search.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/description"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/description.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/kits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/kits"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/kits.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/lights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/lights"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/lights.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

15 changes: 15 additions & 0 deletions docs/_partials/concepts/creator/assets/lookdev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/lookdev"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/lookdev.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

<!--
LookDev Presets
TODO: Name is TBD
-->
11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/optimization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import Description from '@site/docs/_partials/concepts/creator/assets/optimization/description.md'
import Compression from '@site/docs/_partials/concepts/creator/assets/optimization/compression.md'
import DynamicLoading from '@site/docs/_partials/concepts/creator/assets/optimization/dynamicLoading.md'
import Variants from '@site/docs/_partials/concepts/creator/assets/optimization/variants.md'
import LOD from '@site/docs/_partials/concepts/creator/assets/optimization/lod.md'

<Description />
<Compression />
<DynamicLoading />
<Variants />
<LOD />
11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/optimization/compression.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/optimization/compression"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/optimization/compression.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/optimization/description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/optimization/description"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/optimization/description.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/optimization/dynamicLoading"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/optimization/dynamicLoading.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/optimization/lod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/optimization/lod"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/optimization/lod.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/optimization/variants.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/optimization/variants"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/optimization/variants.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/prefabs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/prefabs"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/prefabs.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

5 changes: 5 additions & 0 deletions docs/_partials/concepts/creator/assets/scene.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import Description from '@site/docs/_partials/concepts/creator/assets/scene/description.md'
import Building from '@site/docs/_partials/concepts/creator/assets/scene/building.md'

<Description />
<Building />
11 changes: 11 additions & 0 deletions docs/_partials/concepts/creator/assets/scene/building.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { Concept } from '@site/src/components/Concept'

<Concept
title = "assets/scene/building"
kind = "Core"
category = "Creator"
block = {true}>
This is a dummy description for `concepts/creator/assets/scene/building.md`.
Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.
</Concept>

Loading
Loading