feat: Added docs for the pattern grid turtle

.devcontainer/devcontainer.json

@@ -1,8 +1,24 @@
 {
-  "name": "Python 3.13.2 with MkDocs",
-  "image": "python:3.13.2",
-  "postStartCommand": "pip install poetry && poetry install",
-  "forwardPorts": [
-    8000
-  ]
+  "name": "Advanced Peripherals Docs Dev",
+  "image": "mcr.microsoft.com/devcontainers/python:3.12-bookworm",
+
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {},
+    "ghcr.io/devcontainers/features/common-utils:2": {
+      "configureZshAsDefaultShell": true
+    }
+  },
+
+  "containerEnv": {
+    "POETRY_VIRTUALENVS_IN_PROJECT": "true",
+    "POETRY_VIRTUALENVS_CREATE": "true"
+  },
+
+  "onCreateCommand": "pip install poetry",
+  "updateContentCommand": "poetry install",
+  "postCreateCommand": "git fetch origin gh-pages:gh-pages || true",
+
+  "forwardPorts": [8000],
+
+  "remoteUser": "vscode"
 }

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,5 @@
-blank_issues_enabled: false
+blank_issues_enabled: true
 contact_links:
   - name: Mod issues
-    url: https://github.com/Seniorendi/AdvancedPeripherals/issues
+    url: https://github.com/IntelligenceModding/AdvancedPeripherals/issues
     about: Please report bugs at the advanced peripherals repository. This repository is for documentation only.

.github/workflows/cleanup.yml

@@ -0,0 +1,30 @@
+name: Cleanup PR Preview
+on:
+  pull_request:
+    types: [closed]
+
+permissions:
+  contents: write
+
+jobs:
+  delete-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install mike
+        run: pip install mike
+
+      - name: Delete Preview
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          mike delete --push pr-${{ github.event.number }}

.github/workflows/main.yml

@@ -1,20 +1,56 @@
-name: Publish docs via GitHub Pages
+name: Publish Documentation
 on:
-  workflow_dispatch:
   push:
     branches:
-      - main
+      - '0.[0-9]+'
+
+permissions:
+  contents: write # allows pushing to gh-pages
 
 jobs:
-  build:
-    name: Deploy docs
-    runs-on: self-hosted
+  deploy:
+    runs-on: ubuntu-latest
     steps:
-      - name: Checkout master
-        uses: actions/checkout@v1
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # mike needs history to manage versions
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          pip install poetry
+          poetry install
+
+      - name: Inject Branch Name into Config
+        run: |
+          sed -i "s|BRANCH_NAME_HERE|${{ github.ref_name }}|g" mkdocs.yml
+
+          # Just to verify it worked in the logs
+          grep -E "branch:|edit_uri:" mkdocs.yml
 
-      - name: Deploy docs
-        uses: mhausenblas/mkdocs-deploy-gh-pages@2833747909e0fab61db67a60e8d6e91a871f60aa
+      - name: Deploy Version
         env:
+          EDIT_BRANCH_URI: edit/${{ github.ref_name }}/docs/
+          MKDOCS_PLUGINS: true
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          REQUIREMENTS: requirements.txt
+        run: |
+          # Get current branch name
+          BRANCH_NAME=${GITHUB_REF_NAME}
+
+          # Configure Git
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          if [ "$BRANCH_NAME" == "main" ]; then
+            poetry run mike deploy --push --update-aliases dev
+          elif [ "$BRANCH_NAME" == "0.8" ]; then
+            poetry run mike deploy --push --update-aliases 0.8 canary
+          elif [ "$BRANCH_NAME" == "0.7" ]; then
+            poetry run mike deploy --push --update-aliases 0.7 latest
+          else
+            poetry run mike deploy --push "$BRANCH_NAME"
+          fi

.github/workflows/preview.yml

@@ -0,0 +1,56 @@
+name: PR Preview
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          pip install poetry
+          poetry install
+
+      - name: Deploy Preview
+        env:
+          MKDOCS_PLUGINS: false
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          EDIT_BRANCH_URI: edit/${{ github.head_ref }}/docs/
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Deploy to a version named 'pr-{number}'
+          poetry run mike deploy --push pr-${{ github.event.number }}
+
+          echo "Preview available at: https://docs.advanced-peripherals.de/pr-${{ github.event.number }}/"
+      - name: Post PR Comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: documentation-preview
+          message: |
+            ## 📝 Documentation Preview Ready!
+
+            | Item | Details |
+            | :--- | :--- |
+            | **Status** | ✅ Deployed Successfully |
+            | **Preview Link** | [View Documentation](https://docs.advanced-peripherals.de/pr-${{ github.event.number }}/) |
+            | **Source Branch** | `${{ github.head_ref }}` |
+            | **Version Alias** | `pr-${{ github.event.number }}` |
+
+            > [!NOTE]
+            > The **Edit** buttons on this preview link directly to your branch. Changes made there will update this preview after a few minutes.

.gitignore

@@ -1,2 +1,4 @@
 site/
-.idea
+.idea
+/.cache/
+.vscode

docs/extra.css

@@ -43,4 +43,14 @@ b.si {
     font-size: 1.5rem;
     padding-right: 0.3rem;
     vertical-align: 1rem;
+}
+
+/* Center Markdown Tables (requires md_in_html extension) */
+.center-table {
+    text-align: center;
+}
+
+.md-typeset .center-table :is(td,th):not([align]) {
+    /* Reset alignment for table cells */
+    text-align: initial;
 }

docs/guides/disabled_peripherals.md

@@ -0,0 +1,27 @@
+---
+comments: true
+---
+
+# Disabled Peripherals
+
+!!! failure
+    Only available for 1.19.2-0.7.39r, 1.20.1-0.7.45r, 1.21.1-0.7.57b or newer    
+
+
+Peripherals can be disabled in the configuration file of AP in `{minecraft_folder}/config/Advancedperipherals/peripherals.toml`.
+
+When disabled, these peripherals can still be wrapped but all the functions throw a LuaException. Besides that, you can now find a new function called `peripheralDisabled`.
+You can simply check in your script if a connected peripheral is disabled via the following example.
+
+```lua
+  box = peripheral.find("chat_box") -- (1)
+  if box.peripheralDisabled then -- (2)
+    error("Peripheral is Disabled", 0)  
+  end
+
+  print("Peripheral is not Disabled")
+
+```
+
+1.  Can be any peripheral, as long as it is from AP.
+2.  We just check if the function exists, we don't run it since the function does not exist when the peripheral is not disabled.

docs/guides/filters.md

@@ -12,7 +12,7 @@ These can set the item, count, slots, tags, nbt or fingerprint values.
 
 ## Syntax
 
-### Item/Fluid Name and Tag
+### Item/Fluid/Chemical Name and Tag
 
 The item's/fluid's filter name or tag can be specified with the `name` field.
 If this field is not set, the filter will try to search for items with the right nbt values specified in the `nbt` field
@@ -32,9 +32,36 @@ This can be a tag or a name. To filter for tags, place a `#` in front of the nam
 }
 ```
 
+### Types
+
+!!! success "Added in version 0.8 and 1.21.1-0.7"
+
+Some functions can be used with any type of filter to prevent the same functions with just a different name. These filters are called generic filters.
+They automatically search if the `name` provided is an item, a fluid or a mekanism chemical - in this order. 
+If none could be found, it will return an empty filter with the message `NO_VALID_FILTER_TYPE`.
+
+A type can also be forced using the `type` key.
+Depending on the AP version and the function, the following types can be used: `item`, `fluid` and `chemical`.
+
+```lua
+{
+    name = "minecraft:water"
+    type = "fluid"
+}
+```
+
+The following example would return nil with the message `FLUID_NOT_FOUND` when used in a function.
+```lua
+{
+    name = "minecraft:dirt"
+    type = "fluid"
+}
+```
+
+
 ### Count
 
-The item's/fluid's filter amout can be specified with the `count` field.
+The item's/fluid's filter amount can be specified with the `count` field.
 Standard values are 64 or 1000 for fluids.
 
 ```lua