diff --git a/docs/index.rst b/docs/index.rst index b021be3..07e79f8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,26 @@ .. _swh-graph: -Software Heritage - swh-graph -============================= +Software Heritage - graph service +================================= -.. toctree:: - :maxdepth: 2 - :caption: Contents: +Tooling and service providing fast access to the graph representation of the +Software Heritage archive. The service is in-memory, based on a compressed +representation of the Software Heritage Merkle DAG (see :ref:`data-model`). + + +Overview +-------- +* :doc:`graph compression ` +* :doc:`graph service REST API ` +* :doc:`use cases ` +* :doc:`docker environment ` (for development purposes) -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +Reference Documentation +----------------------- + +.. toctree:: + :maxdepth: 2 + + /apidoc/swh.graph