MobileTeleSystems · dolfinus · May 22, 2024 · May 22, 2024
diff --git a/docs/changelog/next_release/276.improvement.rst b/docs/changelog/next_release/276.improvement.rst
@@ -0,0 +1,4 @@
+Improve Kafka documentation:
+  * Add "Prerequisites" page describing different aspects of connecting to Kafka
+  * Improve "Reading from" and "Writing to" page of Kafka documentation, add more examples and usage notes.
+  * Add "Troubleshooting" page
diff --git a/docs/conf.py b/docs/conf.py
@@ -58,6 +58,7 @@
     "sphinxcontrib.plantuml",
     "sphinx.ext.extlinks",
     "sphinx_favicon",
+    "sphinxcontrib.autodoc_pydantic",
 ]
 numpydoc_show_class_members = False
 autodoc_pydantic_model_show_config = False

diff --git a/docs/connection/db_connection/kafka/format_handling.rst b/docs/connection/db_connection/kafka/format_handling.rst
diff --git a/docs/connection/db_connection/kafka/index.rst b/docs/connection/db_connection/kafka/index.rst
@@ -7,7 +7,9 @@ Kafka
     :maxdepth: 1
     :caption: Connection
 
+    prerequisites
     connection
+    troubleshooting
 
 .. toctree::
     :maxdepth: 1
@@ -31,12 +33,6 @@ Kafka
     read
     write
 
-.. toctree::
-    :maxdepth: 1
-    :caption: Troubleshooting
-
-    format_handling
-
 .. toctree::
     :maxdepth: 1
     :caption: For developers