DOCS updated

MadScrewdriver · Nov 1, 2023 · a90f1ec · a90f1ec
1 parent 650800c
commit a90f1ec
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 6 deletions.
diff --git a/docs/how_to_guide/Rendering a DXF file.rst b/docs/how_to_guide/Rendering a DXF file.rst
@@ -2,7 +2,7 @@
 Rendering a DXF file
 ====================
 
-1. If don't have already, create a :class:`ezdxf.document.Drawing` object to which the renderer
+0. Consider validating the DXF file before rendering it. This can be done by using the `QSketchMetric Validator <https://qsketchmetricvalidator.eu.pythonanywhere.com/>`_.
    will render::
 
     from ezdxf import new

diff --git a/docs/how_to_guide/Validating a parameterized DXF file.rst b/docs/how_to_guide/Validating a parameterized DXF file.rst
@@ -7,7 +7,7 @@ Validating a parametrized DXF file
 QSketchMetric Validator
 -----------------------
 To verify the proper parametrization of a DXF file, use the
-[**QSketchMetric Validator**](https://qsketchmetricvalidator.eu.pythonanywhere.com/). It is a web application that
+`QSketchMetric Validator <https://qsketchmetricvalidator.eu.pythonanywhere.com/>`_. It is a web application that
 allows to upload DXF file and check if it is properly parametrized. In the event of an error,
 the app will provide full debug report. Including place where the error occurred in the DXF file and the error message.
 
@@ -77,19 +77,19 @@ Widgets
    :alt: validation button
    :width: 20%
 
-- **set vars** - button that allows to set variables needed for the parametrization.
+- **Set vars** - button that allows to set variables needed for the parametrization.
 
 .. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/set_vars.png
    :alt: set vars button
    :width: 20%
 
-- **entities** - field that displays the number of entities in a DXF file that can be validated with the account.
+- **Entities** - field that displays the number of entities in a DXF file that can be validated with the account.
 
 .. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/entities.png
    :alt: entities field
    :width: 20%
 
-- **tokens** - field that displays the number of validations that can be performed with current entity limit. After
+- **Tokens** - field that displays the number of validations that can be performed with current entity limit. After
   each validation the number of tokens is decreased by one. When the number of tokens reaches zero, the user will revert
   to the default entity limit of 20 entities.
 
@@ -103,7 +103,7 @@ Widgets
    :alt: increase entities limit button
    :width: 20%
 
-- **question mark** - button that displays a tooltip with a help center.
+- **Question mark** - button that displays a tooltip with a help center.
 
 .. figure:: https://qsketchmetric.readthedocs.io/en/latest/_static/Media/questionmark.png
    :alt: question mark button

diff --git a/docs/tutorials/Parametrizing your first DXF file.rst b/docs/tutorials/Parametrizing your first DXF file.rst
@@ -133,4 +133,7 @@ file, that you can
 `download <https://raw.githubusercontent.com/MadScrewdriver/qsketchmetric/main/docs/_static/DXF/tutorial.dxf>`_ from the
 `QSketchMetric repository <https://github.com/MadScrewdriver/qsketchmetric>`_.
 
+Lastly, we can check if the parametrization is correct by validating it. To do so, follow the
+:ref:`Validation your first DXF file <validator-tutorial>` tutorial.
+
 **Congratulation you created your first parametric DXF file!**
diff --git a/docs/tutorials/Semi-automatic parametrization of a DXF file.rst b/docs/tutorials/Semi-automatic parametrization of a DXF file.rst
@@ -75,6 +75,9 @@ To do so select the entities one by one and scroll down the
 You can change the value of the parameter to any of the above. For example, let's change the value of the
  chalice leg line to `2*c`. This will make the leg line 2 times longer.
 
+Lastly, we can check if the parametrization is correct by validating it. To do so, follow the
+:ref:`Validation your first DXF file <validator-tutorial>` tutorial.
+
 That is it! You have successfully parametrized a DXF file. As you can see semi-automatic parametrization is
 much faster and easier than manual parametrization.
 

diff --git a/docs/tutorials/Validating your first parametric DXF file.rst b/docs/tutorials/Validating your first parametric DXF file.rst
@@ -0,0 +1 @@
+.. _validator-tutorial:
diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst
@@ -15,3 +15,4 @@ Start here if you’re new to QSketchMetric.
    Semi-automatic parametrization of a DXF file
    Rendering a point
    Rendering a custom line style
+   Validating your first parametric DXF file