Restructur and start dedicated pages for user tutorials #7

Merged
6543 merged 8 commits from proper-getting-started into main 2024-08-21 19:13:55 -04:00
6543 commented 2024-08-21 08:04:30 -04:00 (Migrated from github.com)

This ...

  • ... moves the Overview into it's own page and make it more readable.
  • ... starts the creation of an dedicated page tor users to get started.
  • ... add .editorconfig to streamline text format and style
  • ... starts the creation of an dedicated page to explain the terms and architecture
This ... - ... moves the Overview into it's own page and make it more readable. - ... starts the creation of an dedicated page tor users to get started. - ... add .editorconfig to streamline text format and style - ... starts the creation of an dedicated page to explain the terms and architecture
technobaboo commented 2024-08-21 08:06:17 -04:00 (Migrated from github.com)

btw we can probably just remove all the stardust schema docs on the site given there's kdl files in the core repo that do that now

btw we can probably just remove all the stardust schema docs on the site given there's kdl files in the core repo that do that now
6543 (Migrated from github.com) reviewed 2024-08-21 08:06:27 -04:00
@@ -0,0 +7,4 @@
Stardust XR _(formerly known as Stardust)_ is an XR [display server](https://itsfoss.com/display-server) designed for Linux-based systems<!-- (possibly most unix-based too, but untested)-->.<br/>
Unlike traditional display servers that focus on 2D screens, Stardust XR introduces new conventions to utilize unbounded 3D space in virtual or real environments.
## Priorities
6543 (Migrated from github.com) commented 2024-08-21 08:06:27 -04:00

@technobaboo please check if i narrowd it down

@technobaboo please check if i narrowd it down
6543 (Migrated from github.com) reviewed 2024-08-21 08:07:07 -04:00
@@ -0,0 +28,4 @@
## Projects & Components
- [**telescope**](https://github.com/StardustXR/telescope): bundle most used components to have a demo environment set up
6543 (Migrated from github.com) commented 2024-08-21 08:07:06 -04:00

that is the part where I'm most lacking ... I would say merge this pull and discust this list in a new pull

that is the part where I'm most lacking ... I would say merge this pull and discust this list in a new pull
6543 (Migrated from github.com) reviewed 2024-08-21 08:07:39 -04:00
@@ -0,0 +1,35 @@
---
6543 (Migrated from github.com) commented 2024-08-21 08:07:39 -04:00

I have no idea but @technobaboo if you provide me with an scetch I'll create an mermaidjs out of it

I have no idea but @technobaboo if you provide me with an scetch I'll create an mermaidjs out of it
6543 (Migrated from github.com) reviewed 2024-08-21 08:08:24 -04:00
@@ -0,0 +1,5 @@
# Glossary
- **Item**: a virtual object that represents data
- **Panel Shells**: 3D UIs around 2D apps
6543 (Migrated from github.com) commented 2024-08-21 08:08:24 -04:00

this allso needs input from the @technobaboo

this allso needs input from the @technobaboo
6543 commented 2024-08-21 08:09:55 -04:00 (Migrated from github.com)

btw we can probably just remove all the stardust schema docs on the site given there's kdl files in the core repo that do that now

ok we should do that in an seperate pull

I still think the official website should contain the protocol documentation too ... but that could be done with code(docs)-generation and in a seperate subcategory later on ...

> btw we can probably just remove all the stardust schema docs on the site given there's kdl files in the core repo that do that now ok we should do that in an seperate pull I still think the official website should contain the protocol documentation too ... but that could be done with code(docs)-generation and in a seperate subcategory later on ...
technobaboo (Migrated from github.com) reviewed 2024-08-21 08:14:17 -04:00
@@ -0,0 +7,4 @@
Stardust XR _(formerly known as Stardust)_ is an XR [display server](https://itsfoss.com/display-server) designed for Linux-based systems<!-- (possibly most unix-based too, but untested)-->.<br/>
Unlike traditional display servers that focus on 2D screens, Stardust XR introduces new conventions to utilize unbounded 3D space in virtual or real environments.
## Priorities
technobaboo (Migrated from github.com) commented 2024-08-21 08:14:17 -04:00

seems pretty good, yea!!

seems pretty good, yea!!
technobaboo commented 2024-08-21 08:15:25 -04:00 (Migrated from github.com)

also also keep in mind we're probably gonna redo the site entirely soon so any changes we make here don't have to be perfect but are great for if the redo gets delayed or just as a framework

also also keep in mind we're probably gonna redo the site entirely soon so any changes we make here don't have to be perfect but are great for if the redo gets delayed or just as a framework
6543 commented 2024-08-21 08:16:52 -04:00 (Migrated from github.com)

sure there still is lot of TODOs in my pull but it at least make things a bit more discoverable

and if you use it to get some ideas for the new docs thats great too :)

sure there still is lot of TODOs in my pull but it at least make things a bit more discoverable and if you use it to get some ideas for the new docs thats great too :)
technobaboo commented 2024-08-21 08:18:07 -04:00 (Migrated from github.com)

should i just merge this in right now or resolve all the threads?

should i just merge this in right now or resolve all the threads?
6543 commented 2024-08-21 08:20:26 -04:00 (Migrated from github.com)

ah I can do that too - I know some git

ah I can do that too - I know _some_ git
6543 commented 2024-08-21 08:24:39 -04:00 (Migrated from github.com)

ok for the rest I need input from your side ... hop you dont mind

ok for the rest I need input from your side ... hop you dont mind
technobaboo commented 2024-08-21 08:25:02 -04:00 (Migrated from github.com)

i don't mind at all, i'll resolve some threads with more info

i don't mind at all, i'll resolve some threads with more info
technobaboo (Migrated from github.com) reviewed 2024-08-21 08:26:01 -04:00
@@ -0,0 +28,4 @@
## Projects & Components
- [**telescope**](https://github.com/StardustXR/telescope): bundle most used components to have a demo environment set up
technobaboo (Migrated from github.com) commented 2024-08-21 08:26:01 -04:00

sure thing

sure thing
technobaboo (Migrated from github.com) reviewed 2024-08-21 08:48:49 -04:00
@@ -0,0 +1,35 @@
---
technobaboo (Migrated from github.com) commented 2024-08-21 08:48:49 -04:00

image
sorry it took me so long but i got it!

![image](https://github.com/user-attachments/assets/31cf0b01-aa8f-41ac-93ce-ffa2bf869fe5) sorry it took me so long but i got it!
technobaboo (Migrated from github.com) reviewed 2024-08-21 08:49:15 -04:00
@@ -0,0 +1,35 @@
---
technobaboo (Migrated from github.com) commented 2024-08-21 08:49:15 -04:00

it doesn't cover everything but the basic architecture

it doesn't cover everything but the basic architecture
technobaboo (Migrated from github.com) reviewed 2024-08-21 08:55:36 -04:00
@@ -0,0 +1,5 @@
# Glossary
- **Item**: a virtual object that represents data
- **Panel Shells**: 3D UIs around 2D apps
technobaboo (Migrated from github.com) commented 2024-08-21 08:55:35 -04:00

uhhh yeah for now that's probably the only glossary item that's unknown by XR devs, will need to revisit it though

uhhh yeah for now that's probably the only glossary item that's unknown by XR devs, will need to revisit it though
6543 (Migrated from github.com) reviewed 2024-08-21 13:53:04 -04:00
@@ -0,0 +1,35 @@
---
6543 (Migrated from github.com) commented 2024-08-21 13:53:03 -04:00

depends on #9 I just used your image for now ...

~~depends on #9~~ I just used your image for now ...
6543 (Migrated from github.com) reviewed 2024-08-21 14:02:33 -04:00
@@ -0,0 +1,5 @@
# Glossary
- **Item**: a virtual object that represents data
- **Panel Shells**: 3D UIs around 2D apps
6543 (Migrated from github.com) commented 2024-08-21 14:02:33 -04:00

well If you know a good source where the OpenXR glossary is documented I'll just refference it and we can only document stardust specific terms here ... else if such thing does not exist, we can be the list for others ...

not everybody is an XR dev >D

well If you know a good source where the OpenXR glossary is documented I'll just refference it and we can only document stardust specific terms here ... else if such thing does not exist, we can be the list for others ... _not everybody is an XR dev >D_
6543 commented 2024-08-21 14:03:45 -04:00 (Migrated from github.com)

to #9 I still thin for the time being mrermaidjs support should be added, as it is quite helpfull.

for the diagram you provided, that was easyer to just be provided as an image for now ...

to #9 I still thin for the time being mrermaidjs support should be added, as it is quite helpfull. for the diagram you provided, that was easyer to just be provided as an image for now ...
6543 commented 2024-08-21 14:04:06 -04:00 (Migrated from github.com)

@technobaboo I guess this is ready now?

@technobaboo I guess this is ready now?
Sign in to join this conversation.