diff --git a/.github/workflows/deploy_doxygen_page.yml b/.github/workflows/deploy_doxygen_page.yml new file mode 100644 index 00000000..07b8372c --- /dev/null +++ b/.github/workflows/deploy_doxygen_page.yml @@ -0,0 +1,47 @@ +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 "you@example.com" + 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: Merge changes from remote + run: | + git merge origin/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 "deploy(root): Deploying documentation to GitHub Pages" + git pull origin gh-pages + git push origin gh-pages + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/Docs/RFC.txt b/Docs/RFC.txt index 77be15ae..7bf21649 100644 --- a/Docs/RFC.txt +++ b/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 diff --git a/README.md b/README.md index cbdde0ff..62d2315c 100644 --- a/README.md +++ b/README.md @@ -107,10 +107,10 @@ $ docker rm ### :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