Update

Author: LukeGus

.github/workflows/deploy_docs.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: .vitepress/dist
+          path: docs/.vitepress/dist
           name: github-pages
           retention-days: 1
 

docs/.vitepress/config.ts

@@ -36,6 +36,7 @@ export default defineConfig({
           {text: 'Installation', link: '/install'},
           {text: 'OIDC', link: '/oidc'},
           {text: 'Tunnels', link: '/tunnels'},
+          {text: 'Contributing', link: '/contributing'},
           {
             text: "API Reference",
             collapsed: true,

docs/contributing.md

@@ -0,0 +1,53 @@
+# Contributing
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/en/download/) (built with v24)
+- [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- [Git](https://git-scm.com/downloads)
+
+## Installation
+
+1. Clone the repository:
+    ```sh
+    git clone https://github.com/LukeGus/Termix
+    ```
+2. Install the dependencies for the server:
+    ```sh
+    npm install
+    ```
+
+## Running the development server
+
+Run the following command:
+
+```sh
+npm run dev
+```
+
+This will start the Vite server. You can access Termix by going to `http://localhost:5174/`.
+
+## Contributing
+
+1. **Fork the repository**: Click the "Fork" button at the top right of
+   the [repository page](https://github.com/LukeGus/Termix).
+2. **Create a new branch**:
+    ```sh
+    git checkout -b feature/my-new-feature
+    ```
+3. **Make your changes**: Implement your feature, fix, or improvement.
+4. **Commit your changes**:
+    ```sh
+    git commit -m "Add feature: my new feature"
+    ```
+5. **Push to your fork**:
+    ```sh
+    git push origin feature/my-new-feature
+    ```
+6. **Open a pull request**: Go to the original repository and create a PR with a clear description.
+
+## 📝 Guidelines
+
+- Follow the existing code style. Use Tailwind CSS with shadcn components.
+- Include meaningful commit messages.
+- Link related issues when applicable.