upgrade(README): Improve README, clarify instructions and add documentation links

.gitea/workflows/on_pr.yml

@@ -16,13 +16,18 @@ jobs:
           python-version: '3.10.13'
       - name: "Creates virtual environment"
         run: make venv
+      # Loads up the virtualenv
       - name: Activate virtualenv
         run: |
           source venv/bin/activate
           echo PATH=$PATH >> $GITHUB_ENV
+      # Installs playbooks we are using
       - name: Install galaxy requirements
         run: ansible-galaxy install -r requirements.yml
+      # Checks for yaml correctness
       - name: "Run YAML linting"
         run: yamllint -c .yamllint.yml .
+      # Runs an *ansible specific* linter to check for mistakes
+      # and or/bad patterns
       - name: "Run Ansible linting"
         run: ansible-lint

.gitea/workflows/on_push_master.yml

@@ -18,13 +18,18 @@ jobs:
           python-version: '3.10.13'
       - name: "Creates virtual environment"
         run: make venv
+      # Loads up the virtualenv
       - name: Activate virtualenv
         run: |
           source venv/bin/activate
           echo PATH=$PATH >> $GITHUB_ENV
+      # Installs playbooks we are using
       - name: Install galaxy requirements
         run: ansible-galaxy install -r requirements.yml
+      # Checks for yaml correctness
       - name: "Run YAML linting"
         run: yamllint -c .yamllint.yml .
+      # Runs an *ansible specific* linter to check for mistakes
+      # and or/bad patterns
       - name: "Run Ansible linting"
         run: ansible-lint

Makefile

@@ -6,4 +6,4 @@ install:
 	ansible-galaxy install -r requirements.yml
 
 action:
-	act -W .gitea/workflows/on_pr.yml
+	act -W .gitea/workflows/on_pr.yml