From da86366757a531ef0ec892462921fb3a94c0c867 Mon Sep 17 00:00:00 2001 From: ZanzyTHEbar Date: Fri, 20 Jan 2023 02:14:03 +0000 Subject: [PATCH] fix: remove uneeded CNAME and docs folder - add dev_docs guide --- docs/CNAME | 1 - vitepress/docs/src/custom/theme/index.ts | 7 +++ .../src/pages/development/docs/dev_docs.md | 61 +++++++++++++++++++ 3 files changed, 68 insertions(+), 1 deletion(-) delete mode 100644 docs/CNAME create mode 100644 vitepress/docs/src/pages/development/docs/dev_docs.md diff --git a/docs/CNAME b/docs/CNAME deleted file mode 100644 index 2df2fe9..0000000 --- a/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -docs.eyetrackvr.dev \ No newline at end of file diff --git a/vitepress/docs/src/custom/theme/index.ts b/vitepress/docs/src/custom/theme/index.ts index 639f83f..2e37651 100644 --- a/vitepress/docs/src/custom/theme/index.ts +++ b/vitepress/docs/src/custom/theme/index.ts @@ -67,6 +67,13 @@ const theme = { { text: "FAQ", link: "/misc/faq" }, ], }, + { + text: "Development", + collapsible: true, + items: [ + { text: "Docs", link: "/development/docs/dev_docs" }, + ], + }, { text: "Archive", collapsible: true, diff --git a/vitepress/docs/src/pages/development/docs/dev_docs.md b/vitepress/docs/src/pages/development/docs/dev_docs.md new file mode 100644 index 0000000..ce7fd10 --- /dev/null +++ b/vitepress/docs/src/pages/development/docs/dev_docs.md @@ -0,0 +1,61 @@ +# Development Documentation for the EyeTrackVR Docs Site + +This is the documentation for the EyeTrackVR Docs site. It is built using [VitePress](https://vitepress.vuejs.org/). + +## Getting Started + +### Prerequisites + +- [Node.js](https://nodejs.org/en/) (v14.15.4 or higher) +- [Yarn](https://yarnpkg.com/) (v1.22.10 or higher) +- [Git](https://git-scm.com/) (v2.30.1 or higher) +- [VSCode](https://code.visualstudio.com/) (v1.56.2 or higher) + +### Installation + +1. Clone the repo + + ```sh + git clone https://github.com/RedHawk989/EyeTrackVR-Docs.git + ``` + +2. Navigate to the `vitepress` folder + + ```sh + cd vitepress + ``` + +3. Install Yarn packages + + ```sh + yarn + ``` + +4. Start the dev server + + ```sh + yarn dev + ``` + +5. Open the site in your browser + +## Contributing + +### Project Structure + +1. Familiarize yourself with the [VitePress documentation](https://vitepress.vuejs.org/). +2. Then, move on to our project specific documentation below. + +#### Standards + +- All documentation should be written in Markdown or Vue components. +- All file names are snake case *and* lowercase letters. +- Do not make naming changes to the `vitepress` folder. +- Do not make major changes to the `vitepress` folder structure without proir consultation of team members. +- For Vue componentes, follow the [Vue3 docs](https://vuejs.org/guide/introduction.html). + +### Project Specific Documentation + +::: tip +COMING SOON +:::