docs: setup basic tutorial structure

openlawlibrary · Jan 15, 2024 · c308dea · c308dea
1 parent 2e80b85
commit c308dea
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 225 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -42,23 +42,10 @@ allows you to write your own `language server`_ in just a few lines of code::
    :hidden:
    :caption: User Guide
 
-   pages/tutorial
-   pages/user-guide
-   pages/testing
-
-.. toctree::
-   :hidden:
-   :caption: How To
-
-   Handle Invalid Data <howto/handle-invalid-data>
-   Migrate to v1 <howto/migrate-to-v1>
-
-.. toctree::
-   :hidden:
-   :glob:
-   :caption: API Reference
-
-   reference/*
+   tutorial
+   user-guide
+   How To <howto>
+   reference
 
 .. toctree::
    :hidden:
@@ -74,7 +61,9 @@ The documentation is divided up into the following sections
 .. grid:: 1 2 2 2
    :gutter: 2
 
-   .. grid-item-card:: User Guide
+   .. grid-item-card:: Tutorial
+      :link: /tutorial
+      :link-type: doc
       :text-align: center
 
       Step-by-step guides on writing your first language server with *pygls*.
@@ -87,6 +76,8 @@ The documentation is divided up into the following sections
       Short, focused articles on how to acheive a particular outcome
 
    .. grid-item-card:: API Reference
+      :link: /reference
+      :link-type: doc
       :columns: 12
       :text-align: center
 

diff --git a/docs/source/pages/tutorial.rst b/docs/source/pages/tutorial.rst
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
@@ -0,0 +1,12 @@
+.. _tutorial:
+
+Tutorial
+========
+
+Here we have a tutorial
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   tutorial/*
diff --git a/docs/source/tutorial/0-setup.rst b/docs/source/tutorial/0-setup.rst
@@ -0,0 +1,16 @@
+Project Setup
+=============
+
+By the end of this stage you will have everything you need setup in order to follow the rest of this tutorial, including a simple "Hello, World" language server.
+
+**Required Software**
+
+Before continuing with the setup you need following software installed:
+
+* `Visual Studio Code <https://code.visualstudio.com/>`__
+* `Python 3.8+ <https://www.python.org/downloads/>`__
+* `Node JS 18+ <https://nodejs.org/en>`__
+* `Git <https://git-scm.com/>`__
+
+Your First Language Server
+--------------------------
diff --git a/docs/source/pages/testing.rst → docs/source/tutorial/y-testing.rst b/docs/source/pages/testing.rst → docs/source/tutorial/y-testing.rst
diff --git a/docs/source/tutorial/z-next-steps.rst b/docs/source/tutorial/z-next-steps.rst
@@ -0,0 +1,6 @@
+Next Steps
+==========
+
+If you decide you want to publish your language server on the VSCode marketplace this
+`template extension <https://github.com/microsoft/vscode-python-tools-extension-template>`__
+from Microsoft a useful starting point.
diff --git a/docs/source/pages/user-guide.rst → docs/source/user-guide.rst b/docs/source/pages/user-guide.rst → docs/source/user-guide.rst