docs: remove unused documentation embedding settings and add examples section in contributing guide

Author: JakubAndrysek

docs/en/conf.py

@@ -31,10 +31,3 @@
 
 # Tracking ID for Google Analytics
 google_analytics_id = "G-F58JM78930"
-
-# Documentation embedding settings
-# docs_embed_public_root = "https://docs.espressif.com/projects/arduino-esp32-wokwi-test"
-# docs_embed_esp32_relative_root = "../.."
-# docs_embed_launchpad_url = "https://espressif.github.io/esp-launchpad/"
-# docs_embed_github_base_url = "https://github.com/JakubAndrysek/arduino-esp32"
-# docs_embed_github_branch = "docs-embed"

docs/en/contributing.rst

@@ -109,6 +109,41 @@ Also:
     const char * WIFI_FTM_SSID = "WiFi_FTM_Responder"; // SSID of AP that has FTM Enabled
     const char * WIFI_FTM_PASS = "ftm_responder"; // STA Password
 
+
+Examples
+********
+
+All libraries in the Arduino ESP32 core has its own examples. You can found them in the ``libraries/<library_name>/examples/`` folder.
+
+The purpose of these examples is to demonstrate how to use the library features and provide a starting point for users.
+
+If you want to show the example in the documentation, you have two options:
+1. link just the source code file in the documentation using the ``literalinclude`` directive:
+
+.. code-block:: rst
+
+    .. literalinclude:: ../../../libraries/<library_name>/examples/<example_name>/<example_name>.ino
+      :language: arduino
+
+2. Source code with Wokwi simulation embedded in the documentation using the ``wokwi-example`` directive:
+
+.. code-block:: rst
+
+    .. wokwi-example:: libraries/<library_name>/examples/<example_name>/<example_name>.ino
+
+To enable compiling the example in the CI system, you need to add a ``ci.yml`` file in the same folder as the sketch.
+The ``ci.yml`` file is used to specify some configurations for the CI system, like required configurations, supported targets, and more.
+You can enable compilation of the example by adding targets under the ``upload-binary`` directive in the ``ci.yml`` file.
+
+Here is an example of a ``ci.yml`` file that enables compilation for ESP32 and ESP32-S3 targets:
+
+.. code-block:: yaml
+
+    upload-binary:
+      targets:
+        - esp32
+        - esp32s3
+
 Testing
 *******