.. _guide:

User Guide
==========

The guide explains the behavior behind the quick-start examples and highlights
the caveats that matter in real integrations. Start with the core usage pages,
then move into the design notes if you are extending or contributing to
``labapi``.

.. toctree::
   :maxdepth: 1
   :caption: Core Usage

   limitations
   auth
   entries
   json_entries
   api_calls
   index_access
   paths
   exceptions
   clearing_cache

.. toctree::
   :maxdepth: 1
   :caption: Design and Contribution Notes

   architecture
   integration_design
   contributing

Related Pages
-------------

- :ref:`quick_start` for onboarding and common write operations.
- :ref:`examples` for runnable end-to-end workflows.
- :ref:`faq` for troubleshooting local authentication and certificates.