merged new documentation into main branch

.Zeugwerk/config.json

@@ -0,0 +1,24 @@
+{
+  "fileversion": 1,
+  "solution": "TcLog.sln",
+  "projects": [
+    {
+      "name": "TcLogProj",
+      "plcs": [
+        {
+          "version": "0.2.2",
+          "name": "TcLog",
+          "type": "Library",
+          "frameworks": {},
+          "references": {},
+          "repositories": [],
+          "bindings": {},
+          "patches": {
+            "platform": {},
+            "argument": {}
+          }
+        }
+      ]
+    }
+  ]
+}

.github/workflows/documentation.yml

@@ -0,0 +1,26 @@
+name: Documentation
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'TcLog/**'
+  pull_request:
+  workflow_dispatch:
+jobs:
+  Build:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Build
+        uses: Zeugwerk/[email protected]
+        with:
+          username: ${{ secrets.ACTIONS_ZGWK_USERNAME }}
+          password: ${{ secrets.ACTIONS_ZGWK_PASSWORD }}
+          filepath: "."
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: archive/documentation/html

CONTRIBUTING.md

@@ -39,12 +39,8 @@ These tests are complemented by [XUnit](https://xunit.net/) tests in the .NET pr
 
 The project uses the [TcBlack](https://github.com/Roald87/TcBlack) formatter for TwinCAT code. Please make sure to format your code accordingly before creating a pull request. 
 
-The .NET code is formatted using the default Visual Studio formatter.
-
 #### Naming conventions
 
 This project uses [Zeugwerk naming conventions](https://doc.zeugwerk.dev/contribute/contribute_code.html#naming-conventions) for the TwinCAT code.
 
-Unfortunately, the Beckhoff PLC Static Analysis does not support checking custom naming conventions yet. Therefore, please make sure to check your code manually before creating a pull request.
-
-The .NET code follows the default .NET naming conventions.
+Unfortunately, the Beckhoff PLC Static Analysis does not support checking custom naming conventions yet. Therefore, please make sure to check your code manually before creating a pull request.