docs: new docs incoming

- add CI/CD
- remove old docs files
- begin finalizing new docs
This commit is contained in:
ZanzyTHEbar 2023-01-19 14:17:40 +00:00
parent 5411f06754
commit ca241babe6
8 changed files with 9 additions and 8 deletions

View File

@ -6,6 +6,7 @@ export default defineConfig({
outDir: './.vitepress/dist', outDir: './.vitepress/dist',
srcDir: './src/pages', srcDir: './src/pages',
cleanUrls: 'with-subfolders', cleanUrls: 'with-subfolders',
ignoreDeadLinks: true,
/* head: [ /* head: [
[ [
'link', 'link',

View File

@ -20,7 +20,7 @@ Open source and *affordable* VR eye tracker platform for [VRChat](https://hello.
## Hardware ## Hardware
Please check out our [Parts list](https://redhawk989.github.io/EyeTrackVR/parts-list/) and our [full build guide](https://redhawk989.github.io/EyeTrackVR/full-build-guide/) along with our [hardware repo.](https://github.com/RedHawk989/EyeTrackVR-Hardware) Please check out our [Parts list](../how_to_build/parts_list/) and our [full build guide](../how_to_build/full_build_guide/) along with our [hardware repo.](https://github.com/RedHawk989/EyeTrackVR-Hardware)
## About IR Emitter Safety ## About IR Emitter Safety
@ -41,11 +41,11 @@ The safety measures were put in place to REDUCE the potential failure risk. All
</template> </template>
</Alerts> </Alerts>
[Effect of infrared radiation on the lens](./docs/Reference_Docs/saftey/effect_of_ir_on_the_lens.pdf) [Effect of infrared radiation on the lens](../saftey/effect_of_ir_on_the_lens.pdf)
[Training-library Nir Stds](./docs/Reference_Docs/saftey/training-library_nir_stds_20021011.pdf) [Training-library Nir Stds](../saftey/training-library_nir_stds_20021011.pdf)
[AN002_Details on photobiological safety of LED light sources](./docs/Reference_Docs/saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf) [AN002_Details on photobiological safety of LED light sources](../saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
## Firmware ## Firmware
@ -53,7 +53,7 @@ Our firmware called OpenIris is made by `lorow` found [here](https://github.com/
## Headset support ## Headset support
Please take a look at our list of [3d printable mounts](https://redhawk989.github.io/EyeTrackVR/parts-list/#other-parts) and see if your headset is on the list. Please take a look at our list of [3d printable mounts](../how_to_build/parts_list#other-parts) and see if your headset is on the list.
If it is not listed, It is recommended that you try to make a mount, or wait for a skilled community member to create one. If it is not listed, It is recommended that you try to make a mount, or wait for a skilled community member to create one.
#### Contact #### Contact

View File

@ -23,4 +23,4 @@ Important steps may be missing.
This will require some basic Unity knowledge and owning your own avatar. This will require some basic Unity knowledge and owning your own avatar.
### Once you have acknowledged the items above, move on to the [Full Build Guide](/how_to_build/full_build_guide) ### Once you have acknowledged the items above, move on to the [Full Build Guide](../how_to_build/full_build_guide)

View File

@ -10,11 +10,11 @@ import { image_settings } from '../../static/image_settings'
## This page will contain a step-by-step assembly guide ## This page will contain a step-by-step assembly guide
## Step 1: Make sure your have read the [Things to know before you start](/getting_started/things_to_know) guide ## Step 1: Make sure your have read the [Things to know before you start](../getting_started/things_to_know) guide
This will give you a basic overview of the project's status and what to expect currently. This will give you a basic overview of the project's status and what to expect currently.
## Step 2: Order all the parts listed on our [Parts list](/how_to_build/parts_list) ## Step 2: Order all the parts listed on our [Parts list](../how_to_build/parts_list)
Please take note of the fact that hardware still may change, although with more developments it seems like we are going to stick with current hardware. Please take note of the fact that hardware still may change, although with more developments it seems like we are going to stick with current hardware.