Document the CI scripts, Polish update-base script a bit.

Author: Kichura

.github/workflows/build.yml

@@ -1,34 +1,46 @@
+# Clones the repository which then begins with validating the Gradle Wrapper checksum,
+# If the checksum completes, the script then sets up the JDK we need and begins compiling the software,
+# Finally, If the compiled files have been pushed out to the "(something)/build/libs/" directory - It gets uploaded to GitHub.
+
 name: Build Figura using Gradle
 on: [pull_request, push]
+
 jobs:
   build:
     if: github.actor != 'weblate'
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
+
       - name: Validate Gradle wrapper
         uses: gradle/wrapper-validation-action@v1
+
       - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
           distribution: 'temurin'
           java-version: 17
           check-latest: true
+
       - name: Build using Gradle
         run: ./gradlew build
+
       - name: Merge Fabric and Forge JARs
         run: ./gradlew mergeJars
+
       - name: Upload Fabric artifacts to GitHub
         uses: actions/upload-artifact@v3
         with:
           name: Fabric-Artifacts
           path: fabric/build/libs/
+
       - name: Upload Forge artifacts to GitHub
         uses: actions/upload-artifact@v3
         with:
           name: Forge-Artifacts
           path: forge/build/libs/
+
       - name: Upload Merged JAR to GitHub
         uses: actions/upload-artifact@v3
         with:

.github/workflows/update-base.yaml renamed to .github/workflows/update-base.yml

@@ -1,3 +1,6 @@
+# Clones the repository which then begins with searching for modified commits,
+# If found, The workflow in assets repository is then called.
+
 name: Update Base Strings
 
 env:
@@ -14,7 +17,7 @@ jobs:
   update-base:
     runs-on: ubuntu-22.04
     steps:
-      - name: Checkout
+      - name: Checkout Repository
         uses: actions/checkout@v4
         with:
           fetch-depth: ${{ github.event.commits.size }}
@@ -26,7 +29,7 @@ jobs:
       - name: Trigger Workflow in Assets Repository
         uses: benc-uk/workflow-dispatch@v1
         with:
-          workflow: update-base.yaml
+          workflow: update-base.yml
           ref: main
           inputs: |
             {

.gitpod.Dockerfile

@@ -1,3 +1,6 @@
+# Sets up the GitPod shell using the Java 17 workspace which then
+# also sets SDKMAN for GitPod as finalization.
+
 FROM gitpod/workspace-java-17
 USER gitpod
 

.gitpod.yml

@@ -1,3 +1,6 @@
+# Sets up the VScode extensions required for our GitPod script,
+# which includes notifying user if port "25565" should be opened.
+
 image:
   file: .gitpod.Dockerfile
 

jitpack.yml

@@ -1,3 +1,5 @@
+# Deploys the latest stable JDK available and sets it to default without having to manually specify it here,
+# Which includes using temurin as the distribution.
 before_install:
    - curl -s "https://get.sdkman.io" | bash
    - source ~/.sdkman/bin/sdkman-init.sh