Badges working

.github/workflows/make_doxygen.yml

@@ -1,13 +1,14 @@
-# This is a basic workflow to help you get started with Actions, it can run automatically, but i will use it in the same file as the other tests to make sure i onpy up
-
 name: make_doxygen
 
 on:
   push:
-    branches: [ main ] # only run if pushed to main
+    branches: [ main ]
+  pull_request:
+    branches: [ main, develop ]
+    types: [ opened, edited, synchronize]
 
 permissions:
-    contents: write # needed for the Doxygen action
+  contents: write # needed for the Doxygen action
 
 jobs:
   build:
@@ -23,6 +24,7 @@ jobs:
         working-directory: "app/" # default is .
 
     - name: Deploy
+      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
       uses: peaceiris/actions-gh-pages@v3
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -3,9 +3,8 @@
 .platformio/
 .vscode/
 
-# Also ignore the doxygen output folder for now, 
-# but we must copy the output somewhere visible later
-doxygen_out/
+# ignoring doxygen_out, as it generate too many files.  We could improve it by compacting it somehow, or maybe using another documentation engine 
+app/doxygen_out/
 
 # do NOT ignore the files .vscode/tasks.json and .vscode/settings.json
 # these are important for the development environment and will

README.md

@@ -1,3 +1,7 @@
+<!-- [![Actions Status](https://github.com/{user}/{repo}/workflows/{action}/badge.svg)](https://github.com/{user}/{repo}/actions) -->
+[![Build and testing](https://github.com/italocjs/esp32_italoenv/workflows/make_tests/badge.svg)](https://github.com/italocjs/make_tests/actions)
+[![Documentation](https://github.com/italocjs/esp32_italoenv/workflows/make_doxygen/badge.svg)](https://github.com/italocjs/make_doxygen/actions)
+
 # README
 This is a sample of how to integrate CICD with esp32 development. This repository can be started as a docker container containing the required tools, or it can be used as a VSCode devcontainer (open VSCode in the folder, click on reopen as container) to automatically load the environment and install useful extensions for task buttons.
 
@@ -37,6 +41,10 @@ If you need to update the base image (`italocjs/track_env:latest`), you can use
 
 - [`How to build new image`](docs\building_new_image.md)
 
+### Configuring the Doxygen
+- Recommended to use the doxygen wizard
+- Doxygen settings are located in the `app/Doxyfile`
+
 # Final notes:
 This base repository has been created to help me setup my development environment. Feel free to use it as a base for your own projects.
 There is absolutely NO WARRANTY, use at your own risk. if you end up burning your computer, don't blame me, blame yourself.

todo

@@ -0,0 +1 @@
+https://www.drawio.com/blog/diagrams-from-code