Project Structure Reorg: regrouping all examples under examples folder

.github/workflows/build-esp32.yml

@@ -45,13 +45,13 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
 
-      - name: Build Examples
+      - name: Build Arduono Examples
         run: |
-          for i in `ls examples`; do
+          for i in `ls examples/arduino`; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            arduino-cli compile --library . --warnings none -b esp32:esp32:esp32 "examples/$i/$i.ino"
+            arduino-cli compile --library . --warnings none -b esp32:esp32:esp32 "examples/arduino/$i/$i.ino"
           done
 
   arduino-esp32-dev:
@@ -76,13 +76,13 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
 
-      - name: Build Examples
+      - name: Build Arduino Examples
         run: |
-          for i in `ls examples`; do
+          for i in `ls examples/arduino`; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            arduino-cli compile --library . --warnings none -b esp32:esp32:esp32 "examples/$i/$i.ino"
+            arduino-cli compile --library . --warnings none -b esp32:esp32:esp32 "examples/arduino/$i/$i.ino"
           done
 
   platformio-esp32-arduino2:
@@ -113,13 +113,13 @@ jobs:
         run: |
           uv pip install --system -U https://github.com/pioarduino/platformio-core/archive/refs/tags/v6.1.18.zip
 
-      - name: Build Examples
+      - name: Build Arduino Examples
         run: |
-          for i in `ls examples`; do
+          for i in `ls examples/arduino`; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            PLATFORMIO_SRC_DIR=examples/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-arduino-2
+            PLATFORMIO_SRC_DIR=examples/arduino/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-arduino-2
           done
 
   platformio-esp32-arduino-3:
@@ -153,13 +153,13 @@ jobs:
         run: |
           uv pip install --system -U https://github.com/pioarduino/platformio-core/archive/refs/tags/v6.1.18.zip
 
-      - name: Build Examples
+      - name: Build Arduino Examples
         run: |
-          for i in `ls examples`; do
+          for i in `ls examples/arduino`; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            PLATFORMIO_SRC_DIR=examples/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-arduino-3
+            PLATFORMIO_SRC_DIR=examples/arduino/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-arduino-3
           done
 
   platformio-specific-envs:
@@ -192,11 +192,11 @@ jobs:
         run: |
           uv pip install --system -U https://github.com/pioarduino/platformio-core/archive/refs/tags/v6.1.18.zip
 
-      - name: Build Examples
+      - name: Build Arduino Examples
         run: |
-          for i in `ls examples`; do
+          for i in `ls examples/arduino`; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            PLATFORMIO_SRC_DIR=examples/$i PIO_BOARD=esp32dev pio run -e ${{ matrix.env }}
+            PLATFORMIO_SRC_DIR=examples/arduino/$i PIO_BOARD=esp32dev pio run -e ${{ matrix.env }}
           done

.github/workflows/build-esp8266.yml

@@ -45,13 +45,13 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
 
-      - name: Build Examples
+      - name: Build Arduino Examples
         run: |
-          for i in `ls examples`; do
+          for i in `ls examples/arduino`; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            arduino-cli compile --library . --warnings none -b esp8266:esp8266:huzzah "examples/$i/$i.ino"
+            arduino-cli compile --library . --warnings none -b esp8266:esp8266:huzzah "examples/arduino/$i/$i.ino"
           done
 
   platformio-esp8266:
@@ -80,11 +80,11 @@ jobs:
         run: |
           uv pip install --system -U https://github.com/pioarduino/platformio-core/archive/refs/tags/v6.1.18.zip
 
-      - name: Build Examples
+      - name: Build Arduino Examples
         run: |
-          for i in `ls examples`; do
+          for i in `ls examples/arduino`; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            PLATFORMIO_SRC_DIR=examples/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-esp8266
+            PLATFORMIO_SRC_DIR=examples/arduino/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-esp8266
           done

.github/workflows/build-libretiny.yml

@@ -49,11 +49,11 @@ jobs:
         run: |
           uv pip install --system -U https://github.com/pioarduino/platformio-core/archive/refs/tags/v6.1.18.zip
 
-      - name: Build Examples
+      - name: Build Arduino Examples
         run: |
           for i in AsyncResponseStream Auth Headers; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            PLATFORMIO_SRC_DIR=examples/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-libretiny
+            PLATFORMIO_SRC_DIR=examples/arduino/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-libretiny
           done

.github/workflows/build-rpi.yml

@@ -52,13 +52,13 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
 
-      - name: Build Examples
+      - name: Build Arduino Examples
         run: |
-          for i in `ls examples`; do
+          for i in `ls examples/arduino`; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            arduino-cli compile --library . --warnings none -b rp2040:rp2040:${{ matrix.board }} "examples/$i/$i.ino"
+            arduino-cli compile --library . --warnings none -b rp2040:rp2040:${{ matrix.board }} "examples/arduino/$i/$i.ino"
           done
 
   platformio-rpi:
@@ -87,11 +87,11 @@ jobs:
         run: |
           uv pip install --system -U https://github.com/pioarduino/platformio-core/archive/refs/tags/v6.1.18.zip
 
-      - name: Build Examples
+      - name: Build Arduino Examples
         run: |
-          for i in `ls examples`; do
+          for i in `ls examples/arduino`; do
             echo "============================================================="
-            echo "Building examples/$i..."
+            echo "Building examples/arduino/$i..."
             echo "============================================================="
-            PLATFORMIO_SRC_DIR=examples/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-raspberrypi
+            PLATFORMIO_SRC_DIR=examples/arduino/$i PIO_BOARD=${{ matrix.board }} pio run -e ci-raspberrypi
           done

.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 .lh
+/.ci
 /.pio
 /.vscode
 /logs

docs/backup/wiki.md

@@ -376,7 +376,7 @@ Request Continuation is the ability to pause the processing of a request (the ac
 
 This is a common supported use case amongst web servers.
 
-A usage example can be found in the example called [RequestContinuation.ino](https://github.com/ESP32Async/ESPAsyncWebServer/blob/main/examples/RequestContinuation/RequestContinuation.ino)
+A usage example can be found in the example called [RequestContinuation.ino](https://github.com/ESP32Async/ESPAsyncWebServer/blob/main/examples/arduino/RequestContinuation/RequestContinuation.ino)
 
 In the handler receiving the request, just execute:
 

docs/eventsource.md

@@ -5,7 +5,7 @@
 The server includes EventSource (Server-Sent Events) plugin which can be used to send short text events to the browser.
 Difference between EventSource and WebSockets is that EventSource is single direction, text-only protocol.
 
-See the [ServerSentEvents example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/ServerSentEvents/ServerSentEvents.ino).
+See the [ServerSentEvents example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/ServerSentEvents/ServerSentEvents.ino).
 
 ### Setup Event Source on the server
 

docs/filters.md

@@ -10,7 +10,7 @@ Two filter callback are provided for convince:
 - `ON_STA_FILTER` - return true when requests are made to the STA (station mode) interface.
 - `ON_AP_FILTER` - return true when requests are made to the AP (access point) interface.
 
-See the [Filters example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Filters/Filters.ino).
+See the [Filters example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Filters/Filters.ino).
 
 ### Serve different site files in AP mode
 

docs/middleware.md

@@ -40,7 +40,7 @@ AsyncMiddlewareFunction complexAuth([](AsyncWebServerRequest* request, ArMiddlew
 - `LoggerMiddleware`: to log requests globally or per handler with the same pattern as curl. Will also record request processing time
 - `AsyncRateLimitMiddleware`: to limit the number of requests on a windows of time globally or per handler
 
-See the [Middleware example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Middleware/Middleware.ino).
+See the [Middleware example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Middleware/Middleware.ino).
 
 ### CORS with AsyncCorsMiddleware
 
@@ -114,7 +114,7 @@ server.addMiddleware(&authMiddleware); // globally add authentication to the ser
 myHandler.addMiddleware(&authMiddleware); // add authentication to a specific handler
 ```
 
-See the [Auth example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Auth/Auth.ino).
+See the [Auth example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Auth/Auth.ino).
 
 ### Migration to Middleware to improve performance and memory usage
 

docs/requests.md

@@ -44,7 +44,7 @@ if(request->hasHeader("MyHeader")){
 }
 ```
 
-See the [Headers example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Headers/Headers.ino).
+See the [Headers example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Headers/Headers.ino).
 
 ## Path Variable
 
@@ -83,7 +83,7 @@ build_flags =
 
 _NOTE_: By enabling `ASYNCWEBSERVER_REGEX`, `<regex>` will be included. This will add an 100k to your binary.
 
-See the [URIMatcher example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/URIMatcher/URIMatcher.ino) and [URIMatcherTest example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/URIMatcherTest/URIMatcherTest.ino).
+See the [URIMatcher example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/URIMatcher/URIMatcher.ino) and [URIMatcherTest example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/URIMatcherTest/URIMatcherTest.ino).
 
 ### GET, POST and FILE parameters
 
@@ -124,7 +124,7 @@ if(request->hasArg("download"))
   String arg = request->arg("download");
 ```
 
-See the [Params example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Params/Params.ino).
+See the [Params example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Params/Params.ino).
 
 ### FILE Upload handling
 
@@ -142,7 +142,7 @@ void handleUpload(AsyncWebServerRequest *request, String filename, size_t index,
 }
 ```
 
-See the [Upload example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Upload/Upload.ino).
+See the [Upload example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Upload/Upload.ino).
 
 ### Body data handling
 
@@ -177,7 +177,7 @@ AsyncCallbackJsonWebHandler* handler = new AsyncCallbackJsonWebHandler("/rest/en
 server.addHandler(handler);
 ```
 
-See the [Json example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Json/Json.ino).
+See the [Json example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Json/Json.ino).
 
 ### MessagePack body handling
 
@@ -194,4 +194,4 @@ AsyncCallbackMessagePackWebHandler* handler = new AsyncCallbackMessagePackWebHan
 server.addHandler(handler);
 ```
 
-See the [MessagePack example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/MessagePack/MessagePack.ino).
+See the [MessagePack example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/MessagePack/MessagePack.ino).

docs/responses.md

@@ -15,7 +15,7 @@
 
 This will send error 400 instead of 200.
 
-See the [example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Replace/Replace.ino).
+See the [example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Replace/Replace.ino).
 
 ## Request Continuation
 
@@ -63,7 +63,7 @@ if (auto request = requestPtr.lock()) {
 }
 ```
 
-See the [RequestContinuation example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/RequestContinuation/RequestContinuation.ino) and [RequestContinuationComplete example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/RequestContinuationComplete/RequestContinuationComplete.ino).
+See the [RequestContinuation example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/RequestContinuation/RequestContinuation.ino) and [RequestContinuationComplete example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/RequestContinuationComplete/RequestContinuationComplete.ino).
 
 ## Responses
 
@@ -77,7 +77,7 @@ request->redirect("/login");
 request->redirect("http://esp8266.com");
 ```
 
-See the [Redirect example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Redirect/Redirect.ino).
+See the [Redirect example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Redirect/Redirect.ino).
 
 ### Basic response with HTTP Code
 
@@ -139,7 +139,7 @@ const char index_html[] PROGMEM = "..."; // large char array, tested with 14k
 request->send_P(200, "text/html", index_html, processor);
 ```
 
-See the [Templates example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Templates/Templates.ino).
+See the [Templates example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Templates/Templates.ino).
 
 ### Send large webpage from PROGMEM containing templates and extra headers
 
@@ -291,7 +291,7 @@ request->send(LittleFS, "/index.htm", "text/plain");
 request->send(LittleFS, "/index.htm", String(), true);
 ```
 
-See the [StaticFile example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/StaticFile/StaticFile.ino).
+See the [StaticFile example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/StaticFile/StaticFile.ino).
 
 ### Respond with content coming from a File and extra headers
 
@@ -361,7 +361,7 @@ request->send("text/plain", 128, [](uint8_t *buffer, size_t maxLen, size_t index
 });
 ```
 
-See the [ChunkResponse example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/ChunkResponse/ChunkResponse.ino).
+See the [ChunkResponse example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/ChunkResponse/ChunkResponse.ino).
 
 ### Respond with content using a callback and extra headers
 
@@ -507,7 +507,7 @@ response->addHeader("Server","ESP Async Web Server");
 request->send(response);
 ```
 
-See the [ChunkRequest example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/ChunkRequest/ChunkRequest.ino) and [ChunkRetryResponse example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/ChunkRetryResponse/ChunkRetryResponse.ino).
+See the [ChunkRequest example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/ChunkRequest/ChunkRequest.ino) and [ChunkRetryResponse example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/ChunkRetryResponse/ChunkRetryResponse.ino).
 
 ### Chunked Response containing templates
 
@@ -585,7 +585,7 @@ response->print("</body></html>");
 request->send(response);
 ```
 
-See the [AsyncResponseStream example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/AsyncResponseStream/AsyncResponseStream.ino).
+See the [AsyncResponseStream example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/AsyncResponseStream/AsyncResponseStream.ino).
 
 ### ArduinoJson Basic Response
 
@@ -624,7 +624,7 @@ response->setLength();
 request->send(response);
 ```
 
-See the [Json example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Json/Json.ino).
+See the [Json example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Json/Json.ino).
 
 ### MessagePack Response
 
@@ -643,7 +643,7 @@ response->setLength();
 request->send(response);
 ```
 
-See the [MessagePack example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/MessagePack/MessagePack.ino).
+See the [MessagePack example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/MessagePack/MessagePack.ino).
 
 ## Adding Default Headers
 
@@ -672,7 +672,7 @@ webServer.onNotFound([](AsyncWebServerRequest *request) {
 });
 ```
 
-See the [CORS example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/CORS/CORS.ino).
+See the [CORS example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/CORS/CORS.ino).
 
 ## Bad Responses
 

docs/routing.md

@@ -121,7 +121,7 @@ Usage:
   server.addRewrite( new OneParamRewrite("/radio/{frequence}", "/radio?f={frequence}") );
 ```
 
-See the [Rewrite example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/Rewrite/Rewrite.ino).
+See the [Rewrite example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/Rewrite/Rewrite.ino).
 
 ## Remove handlers and rewrites
 

docs/websockets.md

@@ -40,7 +40,7 @@ I recommend to use the official API `AsyncWebSocketMessageBuffer` to retain furt
 The server includes a web socket plugin which lets you define different WebSocket locations to connect to
 without starting another listening service or using different port
 
-See the [WebSocket example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/WebSocket/WebSocket.ino) and [WebSocketEasy example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/WebSocketEasy/WebSocketEasy.ino).
+See the [WebSocket example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/WebSocket/WebSocket.ino) and [WebSocketEasy example here](https://github.com/ESP32Async/ESPAsyncWebServer/blob/master/examples/arduino/WebSocketEasy/WebSocketEasy.ino).
 
 ### Async WebSocket Event
 

idf_component_examples/catchall/main/idf_component.yml → examples/idf_component/catchall/main/idf_component.yml

@@ -2,5 +2,5 @@
 dependencies:
   esp32async/espasyncwebserver:
     version: "*"
-    override_path: "../../../"
+    override_path: "../../../../"
     pre_release: true