docs: create a "How To" section

openlawlibrary · Jan 10, 2024 · 5c919d1 · 5c919d1
1 parent ab9ed88
commit 5c919d1
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/docs/source/howto.rst b/docs/source/howto.rst
@@ -0,0 +1,8 @@
+How To Guides
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   Handle Invalid Data <howto/handle-invalid-data>
+   Migrate to v1 <howto/migrate-to-v1>
diff --git a/docs/source/pages/migrating-to-v1.rst → docs/source/howto/migrate-to-v1.rst b/docs/source/pages/migrating-to-v1.rst → docs/source/howto/migrate-to-v1.rst
@@ -1,5 +1,5 @@
-Migrating to v1.0
-=================
+How To Migrate to v1.0
+======================
 
 The most notable change of the ``v1.0`` release of ``pygls`` is the removal of its hand written LSP type and method definitions in favour of relying on the types provided by the `lsprotocol`_ library which are automatically generated from the LSP specification.
 As as side effect this has also meant the removal of `pydantic`_ as a dependency, since ``lsprotocol`` uses `attrs`_ and `cattrs`_ for serialisation and validation.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -41,10 +41,15 @@ User Guide
    pages/tutorial
    pages/user-guide
    pages/testing
-   pages/migrating-to-v1
    pages/reference
 
 
+.. toctree::
+   :hidden:
+   :caption: How To
+
+   Migrate to v1 <howto/migrate-to-v1>
+
 .. _Language Server Protocol: https://microsoft.github.io/language-server-protocol/specification
 .. _Language server: https://langserver.org/
 .. _pygls: https://github.com/openlawlibrary/pygls