feat(workflows): Add Doxygen GitHub Pages deployment workflow and upd…

…ate Flakkari RFC documentation

.github/workflows/deploy_doxygen_page.yml

@@ -0,0 +1,42 @@
+name: Doxygen GitHub Pages Deploy Action
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  doxygen:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "Your Name"
+
+      - name: Install Doxygen
+        run: |
+          sudo apt-get install doxygen
+
+      - name: Generate Doxygen Documentation
+        run: |
+          doxygen Doxyfile.cfg
+
+      - name: Create gh-pages branch
+        run: |
+          git checkout -b gh-pages
+
+      - name: Copy documentation to gh-pages branch
+        run: |
+          cp -r Docs/Flakkari/html/* .
+
+      - name: Push documentation to gh-pages branch
+        run: |
+          git add .
+          git commit -m "Deploying documentation to GitHub Pages"
+          git push origin gh-pages
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Docs/RFC.txt

@@ -42,17 +42,17 @@ Copyright Notice
 
 Table of Contents
 
-   1. Introduction .................................................... 3
-   2. Protocol Overview .............................................. 3
-   3. Message Format .................................................. 4
-      3.1. Header Structure .......................................... 4
-      3.2. FlakkariEventId Enum ...................................... 5
-      3.3. Priority Enum ............................................. 6
-      3.4. ApiVersion Enum ............................................ 6
-   4. Message Semantics .............................................. 7
-      4.1. System Messages ........................................... 7
-      4.2. Network Messages .......................................... 8
-      4.3. Game Messages ............................................. 9
+   1. Introduction ...................................................  3
+   2. Protocol Overview ..............................................  3
+   3. Message Format .................................................  4
+      3.1. Header Structure ..........................................  4
+      3.2. FlakkariEventId Enum ......................................  5
+      3.3. Priority Enum .............................................  6
+      3.4. ApiVersion Enum ...........................................  6
+   4. Message Semantics ..............................................  7
+      4.1. System Messages ...........................................  7
+      4.2. Network Messages ..........................................  8
+      4.3. Game Messages .............................................  9
       4.4. User Messages ............................................. 10
    5. Security Considerations ........................................ 11
    6. IANA Considerations ............................................ 12

README.md

@@ -107,10 +107,10 @@ $ docker rm <container-id>
 ### :wrench: **DOCUMENTATION**
 
 Wiki:
-- [**Technical Documentation & Wiki**](https://github.com/MasterLaplace/Flakkari/wiki)
+- [**Technical Documentation & Wiki**](https://MasterLaplace.github.io/Flakkari/)
 
 For detailed documentation on the Flakkari protocol, see:
-- [**Flakkari Protocol Documentation**](https://github.com/MasterLaplace/Flakkari/wiki/Flakkari-protocol)
+- [**Flakkari Protocol Documentation**](Docs/RFC.txt)
 
 
 ## :rocket: LATEST RELEASE