DOCS updated validator tutorial

MadScrewdriver · Nov 1, 2023 · 079c85a · 079c85a
1 parent f7436ab
commit 079c85a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/docs/explanation/Debug report.rst b/docs/explanation/Debug report.rst
@@ -0,0 +1,11 @@
+.. _debug:
+
+Debug report
+============
+
+.. _error-messages:
+Error messages
+--------------
+
+Dxf debug report
+---------------
diff --git a/docs/explanation/index.rst b/docs/explanation/index.rst
@@ -11,3 +11,5 @@ Explanation
 
    Mtext
    Virtual layer
+   Debug report
+
diff --git a/docs/how_to_guide/Validating a parameterized DXF file.rst b/docs/how_to_guide/Validating a parameterized DXF file.rst
@@ -52,8 +52,8 @@ Validation process
        :width: 50%
 
 
-    2. If the file is not properly parametrized, the app will display an **error message** and a **debug report** will
-       be available for download.
+    2. If the file is not properly parametrized, the app will display an :ref:`error message <error-messages>` and a
+       :ref:`debug report <debug>`  will be available for download.
 
     .. figure:: https://raw.githubusercontent.com/MadScrewdriver/qsketchmetric/main/docs/_static/Media/error.gif
        :alt: validation success

diff --git a/docs/tutorials/Validating your first parametric DXF file.rst b/docs/tutorials/Validating your first parametric DXF file.rst
@@ -58,7 +58,7 @@ The error is telling us that the `h` variable is not defined.
 This is because the validator does not know what the `h` variable is while
 calculating the ``chalice_foot_radius`` variable.
 
-Download the debug report by clicking the `Debug report` button and open it in QCAD Professional.
+Download the debug report by clicking the :ref:`Debug report <debug>` button and open it in QCAD Professional.
 
 We can see that every entity got greyed out accept of the MTEXT entity. It is because the MTEXT entity is the
 place where the error occurred while calculating the ``chalice_foot_radius`` variable.