From 5ffb95f945c5bdd0a052e626a31f77aa66d692c1 Mon Sep 17 00:00:00 2001 From: harshqa-webkul Date: Wed, 19 Nov 2025 19:51:24 +0530 Subject: [PATCH 1/4] deploy.yml added --- .github/workflows/deploy.yml | 36 +++++++++++++++++++++++++++++++++++ ReadMe copy.md | 1 - readme.md | 37 ------------------------------------ 3 files changed, 36 insertions(+), 38 deletions(-) create mode 100644 .github/workflows/deploy.yml delete mode 100644 ReadMe copy.md delete mode 100644 readme.md diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..20c8c7b --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,36 @@ +name: Deploy to GitHub Pages + +permissions: + contents: write + +on: + push: + branches: + - master + +jobs: + publish-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout Repository 🛎️ + uses: actions/checkout@v4 + with: + persist-credentials: false + + - name: Setup Node.js 🔧 + uses: actions/setup-node@v4 + with: + node-version: 18 + + - name: Install Dependencies 📦 + run: npm ci + + - name: Build Documentation 🏗 + run: npm run docs:build + + - name: Deploy to GitHub Pages 🚀 + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: .vitepress/dist + cname: docs.aureuserp.com diff --git a/ReadMe copy.md b/ReadMe copy.md deleted file mode 100644 index 1155742..0000000 --- a/ReadMe copy.md +++ /dev/null @@ -1 +0,0 @@ -Aureus User Guide created diff --git a/readme.md b/readme.md deleted file mode 100644 index a4bb019..0000000 --- a/readme.md +++ /dev/null @@ -1,37 +0,0 @@ -# Aureus Erp Documentation - -You can find the online version of the Aureus Erp documentation at [https://devdocs.aureuserp.com](https://devdocs.aureuserp.com). - -## Contribution guide - -For contributing to the docs, you first need to set up the project, - -- Fork the repository. - -- Clone your fork. - -- Follow the [Install Dependencies](#Install-dependencies) section. - -Make sure your PR follows all these points, - -- Before writing the docs just make sure to check that if that topic is already written or not. - -- Make sure your markdown indentation should be proper. You can install `mark-down` lint also. This will help you to follow the markdown conventions. - -- If you are creating new files for the docs, then make sure the filename should be `kebab-case`. For e.g. `file-1.md`, `file-2.md`. - -## Install dependencies - -- Run the following command, - - ```sh - npm install - ``` - -- Run the docs locally, - - ```sh - npm run docs:dev - ``` - -- Open your browser and go to [http://localhost:5173](http://localhost:5173). From fae3a3d3424d06848515f753c4d027ecdbc8dbd8 Mon Sep 17 00:00:00 2001 From: harshqa-webkul Date: Wed, 19 Nov 2025 19:58:54 +0530 Subject: [PATCH 2/4] branch changed --- .github/workflows/deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 20c8c7b..5461c18 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -6,7 +6,7 @@ permissions: on: push: branches: - - master + - main jobs: publish-docs: From 2cf8d86ad6ec3c5d855a0ec1b0b488a931fcaf56 Mon Sep 17 00:00:00 2001 From: harshqa-webkul Date: Wed, 19 Nov 2025 20:12:49 +0530 Subject: [PATCH 3/4] readme added --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..afdc9bd --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Aureus ERP Documentation + +You can find the online version of the Aureus Erp documentation at [https://docs.aureuserp.com](https://docs.aureuserp.com). + +## Contribution guide + +For contributing to the docs, you first need to set up the project, + +- Fork the repository. + +- Clone your fork. + +- Follow the [Install Dependencies](#Install-dependencies) section. + +Make sure your PR follows all these points, + +- Before writing the docs just make sure to check that if that topic is already written or not. + +- Make sure your markdown indentation should be proper. You can install `mark-down` lint also. This will help you to follow the markdown conventions. + +- If you are creating new files for the docs, then make sure the filename should be `kebab-case`. For e.g. `file-1.md`, `file-2.md`. + +## Install dependencies + +- Run the following command, + + ```sh + npm install + ``` + +- Run the docs locally, + + ```sh + npm run docs:dev + ``` + +- Open your browser and go to [http://localhost:5173](http://localhost:5173). From 0bd2ee8844a5c100727094f4a74826ca12ec4228 Mon Sep 17 00:00:00 2001 From: harshqa-webkul Date: Wed, 19 Nov 2025 20:14:43 +0530 Subject: [PATCH 4/4] changes made --- .github/workflows/deploy.yml | 36 ------------------------------------ 1 file changed, 36 deletions(-) delete mode 100644 .github/workflows/deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml deleted file mode 100644 index 5461c18..0000000 --- a/.github/workflows/deploy.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: Deploy to GitHub Pages - -permissions: - contents: write - -on: - push: - branches: - - main - -jobs: - publish-docs: - runs-on: ubuntu-latest - steps: - - name: Checkout Repository 🛎️ - uses: actions/checkout@v4 - with: - persist-credentials: false - - - name: Setup Node.js 🔧 - uses: actions/setup-node@v4 - with: - node-version: 18 - - - name: Install Dependencies 📦 - run: npm ci - - - name: Build Documentation 🏗 - run: npm run docs:build - - - name: Deploy to GitHub Pages 🚀 - uses: peaceiris/actions-gh-pages@v4 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: .vitepress/dist - cname: docs.aureuserp.com