docs: update some more hints to docs

.gitlab-ci.yml

@@ -178,9 +178,11 @@ build_upstream_examples:
 
 build_docs:
     stage: build
-    image: $CI_DOCKER_REGISTRY/esp-idf-doc-env:v4.4-1-v4
+    image: $CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.0:2-3
     tags:
         - build
+    variables:
+        ESP_DOCS_LATEST_BRANCH_NAME: "main"
     artifacts:
         when: always
         paths:
@@ -194,11 +196,13 @@ build_docs:
 
 .deploy_docs_template:
     stage: docs
-    image: $CI_DOCKER_REGISTRY/esp-idf-doc-env:v4.4-1-v4
+    image: $CI_DOCKER_REGISTRY/esp-idf-doc-env-v5.0:2-3
     tags:
         - docs
     needs:
         - build_docs
+    variables:
+        ESP_DOCS_LATEST_BRANCH_NAME: "main"
     script:
         - source ${CI_PROJECT_DIR}/docs/utils.sh
         - add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER

components/esp_matter/esp_matter_core.h

@@ -217,7 +217,7 @@ uint16_t get_id(endpoint_t *endpoint);
  *
  * @param[in] endpoint Endpoint handle.
  * @param[in] device_type_id Device type ID.
- * @parma[in] device_type_version Device type version.
+ * @param[in] device_type_version Device type version.
  *
  * @return ESP_OK on success.
  * @return error in case of failure.

docs/Doxyfile

@@ -59,3 +59,10 @@ GENERATE_RTF    = NO
 ## Skip distracting progress messages
 ##
 QUIET = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED   = NO

docs/en/developing.rst

@@ -66,6 +66,18 @@ To clone the esp-matter repository with all the submodules, use the following co
    ./install.sh
    cd ..
 
+Note: If it runs into some errors like:
+
+   ::
+
+      dial tcp 108.160.167.174:443: connect: connection refused
+
+   ::
+
+      ConnectionResetError: [Errno 104] Connection reset by peer
+
+It's probably caused by some network connectivity issue, a VPN is required for most of the cases.
+
 2.1.3 Configuring the Environment
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -166,7 +178,11 @@ CHIP Tool is an example implementation of Matter commissioner and used for devel
 2.2.1 Test Setup (CHIP Tool)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-A host-based chip-tool can be used as a commissioner to commission and control a Matter device.
+A host-based chip-tool can be used as a commissioner to commission and control a Matter device. During the previous ``install.sh`` step, the ``chip-tool`` is generated under the folder:
+
+::
+
+   ${ESP_MATTER_PATH}/connectedhomeip/connectedhomeip/examples/chip-tool/out
 
 2.2.1.1 Commissioning
 ^^^^^^^^^^^^^^^^^^^^^

docs/requirements.txt

@@ -1 +1 @@
-esp-docs==0.2.1
+esp-docs>=1.2.0