*************
Documentation
*************

Here you can find the documentation for the Yo-Ga-X framework itself.

We'll first give an in-depth explanation about several key concepts:

- the :doc:`authentication workflow </documentation/key-concepts/authentication>` based on Participant credentials used throughout the ecosystem,
- :doc:`/documentation/key-concepts/contract-negotiation` between Participants via which the informed consent is realized,
- :doc:`/documentation/key-concepts/verifiable-credentials`, fundamental to the above and many more aspects of the framework.

Further, you can find complete and detailed overviews about the framework and its architecture:

- a :doc:`list of all services, as well as other software components </documentation/architecture/services>`, including short descriptions about their functionality and links to their repositories, containing source code as well as installation/configuration instructions,
- the :doc:`/documentation/architecture/data-architecture`, a graphical overview about the data that is exchanged between all components and its relations,
- the :doc:`/documentation/architecture/flows`, detailed graphical descriptions of the processes supported by the framework, and
- finally, :doc:`a large-scale overview </documentation/architecture/big-picture>` combining all flows into a big picture of the entire architecture.

.. toctree::
    :maxdepth: 3
    :hidden:

    key-concepts/index.rst
    architecture/index.rst