diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index 60f1a85..496f1d6 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -71,6 +71,12 @@ export default defineConfig({ items: [ { text: 'WHMCS', link: '/integrations/whmcs' }, ] + }, + { + text: 'Contributing', + items: [ + { text: 'Documentation', link: '/contributing/documentation' }, + ] } ], diff --git a/docs/contributing/documentation.md b/docs/contributing/documentation.md new file mode 100644 index 0000000..970db9b --- /dev/null +++ b/docs/contributing/documentation.md @@ -0,0 +1,15 @@ +# Contributing to Phyre Panel documentation + +The documentation is built using [VitePress](https://vitepress.vuejs.org). There are a couple of requirements to contribute to it. + +## Requirements + +- Node.js 16 or higher +- A code editor with Vue and Markdown support. We suggest [Visual Studio Code](https://code.visualstudio.com). + +## Viewing your changes locally + +1. Open the project folder in your terminal. +2. If the dependencies are not installed yet, install them by running `npm install`. +3. Run `npm run docs:dev`. +4. Navigate to `http://localhost:5173` in your browser.