mirror of
https://github.com/EyeTrackVR/EyeTrackVR-Docs.git
synced 2025-09-26 23:09:15 +08:00
fix: remove uneeded CNAME and docs folder
- add dev_docs guide
This commit is contained in:
parent
c7f5b2ad45
commit
da86366757
@ -1 +0,0 @@
|
|||||||
docs.eyetrackvr.dev
|
|
@ -67,6 +67,13 @@ const theme = {
|
|||||||
{ text: "FAQ", link: "/misc/faq" },
|
{ text: "FAQ", link: "/misc/faq" },
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
text: "Development",
|
||||||
|
collapsible: true,
|
||||||
|
items: [
|
||||||
|
{ text: "Docs", link: "/development/docs/dev_docs" },
|
||||||
|
],
|
||||||
|
},
|
||||||
{
|
{
|
||||||
text: "Archive",
|
text: "Archive",
|
||||||
collapsible: true,
|
collapsible: true,
|
||||||
|
61
vitepress/docs/src/pages/development/docs/dev_docs.md
Normal file
61
vitepress/docs/src/pages/development/docs/dev_docs.md
Normal file
@ -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
|
||||||
|
:::
|
Loading…
Reference in New Issue
Block a user