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

…ate Flakkari RFC documentation
MasterLaplace · Dec 28, 2023 · 0c55282 · 0c55282
1 parent e660133
commit 0c55282
Show file tree

Hide file tree

Showing 10 changed files with 238 additions and 7 deletions.
diff --git a/.github/workflows/deploy_doxygen_page.yml b/.github/workflows/deploy_doxygen_page.yml
@@ -31,7 +31,7 @@ jobs:
 
       - name: Copy documentation to gh-pages branch
         run: |
-          cp -r Docs/Flakkari/html/* .
+          cp -r docs/Flakkari/html/* docs/
 
       - name: Push documentation to gh-pages branch
         run: |

diff --git a/.gitignore b/.gitignore
@@ -570,6 +570,8 @@ _deps
 flakkari
 r-type_server
 
-Docs/Flakkari/
+docs/Flakkari/
 build/
 .Test/
+poc/
+Game/
diff --git a/Doxyfile.cfg b/Doxyfile.cfg
@@ -61,14 +61,14 @@ PROJECT_BRIEF          = "Flakkari made in C++ for EPITECH project."
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = ./Docs/Images/Flakkari-200x200.png
+PROJECT_LOGO           = ./docs/Images/Flakkari-200x200.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = ./Docs/Flakkari
+OUTPUT_DIRECTORY       = ./docs/Flakkari
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
 # sub-directories (in 2 levels) under the output directory of each output format
@@ -1028,7 +1028,7 @@ EXCLUDE_SYMLINKS       = NO
 
 EXCLUDE_PATTERNS       = build/* \
                          .github/workflows/* \
-                         Docs/Flakkari \
+                         docs/Flakkari \
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# ME : <p align="center">Flakkari<br><br><img src="Docs/Images/Flakkari.png" alt="Flakkari logo" style="height: 200px"></p>
+# ME : <p align="center">Flakkari<br><br><img src="docs/Images/Flakkari.png" alt="Flakkari logo" style="height: 200px"></p>
 
 <p align="center">
     <h3 align="center">📦 Download &#xa0; : &#xa0;
@@ -110,7 +110,7 @@ Wiki:
 - [**Technical Documentation & Wiki**](https://MasterLaplace.github.io/Flakkari/)
 
 For detailed documentation on the Flakkari protocol, see:
-- [**Flakkari Protocol Documentation**](Docs/RFC.txt)
+- [**Flakkari Protocol Documentation**](docs/RFC.txt)
 
 
 ## :rocket: LATEST RELEASE

diff --git a/Docs/Images/Flakkari-200x200.png → docs/Images/Flakkari-200x200.png b/Docs/Images/Flakkari-200x200.png → docs/Images/Flakkari-200x200.png
diff --git a/Docs/Images/Flakkari.png → docs/Images/Flakkari.png b/Docs/Images/Flakkari.png → docs/Images/Flakkari.png
diff --git a/Docs/RFC.txt → docs/RFC.txt b/Docs/RFC.txt → docs/RFC.txt
diff --git a/docs/diagram.drawio b/docs/diagram.drawio
diff --git a/Docs/examples/UDPClient.hpp → docs/examples/UDPClient.hpp b/Docs/examples/UDPClient.hpp → docs/examples/UDPClient.hpp
diff --git a/Docs/examples/UDPServer.hpp → docs/examples/UDPServer.hpp b/Docs/examples/UDPServer.hpp → docs/examples/UDPServer.hpp