Skip to content

Commit

Permalink
Added tutorials to top-level/hid tocs
Browse files Browse the repository at this point in the history
  • Loading branch information
shihab-dls committed Mar 24, 2024
1 parent 4481ffe commit f450c16
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,33 @@
How the documentation is structured
-----------------------------------

The documentation is split into 2 sections:
The documentation is split into 4 sections:

.. grid:: 2
:gutter: 4

.. grid-item-card:: :material-regular:`person;4em`
:link: user/index
:link-type: doc
.. grid-item-card:: :material-regular:`directions_walk;3em`

.. toctree::
:caption: Tutorials
:maxdepth: 1
:hidden:

user/tutorials/tutorial1_blinking_leds.rst
user/tutorials/tutorial2_position_capture.rst
user/tutorials/tutorial3_position_compare.rst
user/tutorials/tutorial4_snake_scan.rst

+++

The User Guide contains documentation on how to install and use PandABlocks.github.io.
Tutorials for installation and typical usage. New users start here.

.. grid-item-card:: :material-regular:`task;3em`

.. toctree::
:caption: How-to Guides
:maxdepth: 1
:hidden:

developer/how-to/contribute
developer/how-to/update-tools
Expand All @@ -39,6 +48,7 @@ The documentation is split into 2 sections:
.. toctree::
:caption: Explanations
:maxdepth: 1
:hidden:

developer/explanations/decisions

Expand All @@ -51,6 +61,7 @@ The documentation is split into 2 sections:
.. toctree::
:caption: Reference
:maxdepth: 1
:hidden:

developer/reference/standards
user/reference/migration_guide
Expand Down

0 comments on commit f450c16

Please sign in to comment.