Skip to content

Commit

Permalink
Adding References
Browse files Browse the repository at this point in the history
  • Loading branch information
Shihab Suliman committed Mar 22, 2024
1 parent b29bca1 commit 1cb6067
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@ The documentation is split into 2 sections:
:link: user/index
:link-type: doc

+++

The User Guide contains documentation on how to install and use PandABlocks.github.io.

.. grid-item-card:: :material-regular:`code;4em`
:link: developer/index
:link-type: doc

+++

The Developer Guide contains documentation on how to develop and contribute changes back to PandABlocks.github.io.

.. grid-item-card:: :material-regular:`info;3em`
Expand All @@ -30,9 +34,26 @@ The documentation is split into 2 sections:
:maxdepth: 1

developer/explanations/decisions

+++

Explanations of how and why the architecture is why it is.

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

.. toctree::
:caption: Reference
:maxdepth: 1

developer/reference/standards
user/reference/migration_guide
user/reference/release_compatibility
../genindex

+++

Technical reference material including APIs and release notes.

The Existing Documentation for the PandABlocks projects can be found:

======================= =====================================================
Expand Down

0 comments on commit 1cb6067

Please sign in to comment.