From ea6fdcbd0fc8783a480004c9d3efd5f7d1e7e3b2 Mon Sep 17 00:00:00 2001
From: Danura30082 <135959478+Danura30082@users.noreply.github.com>
Date: Fri, 29 Nov 2024 15:18:43 +0100
Subject: [PATCH] Adding comments to github workflow

---
 .github/workflows/main.yml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 17a8d8e..7017339 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -14,9 +14,9 @@ jobs:
         uses: actions/setup-python@v2 # sets up a Python environment 
         with:
           python-version: '3.x'
-      - name: Install MkDocs   
+      - name: Install MkDocs   # installs MkDocs
         run: pip install mkdocs 
-      - name: Deploy with MkDocs
+      - name: Deploy with MkDocs # deploys the site using MkDocs
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # allows the workflow to access the repository otherwise it will fail due to laking write permissions
         run: mkdocs gh-deploy --force
\ No newline at end of file