diff --git a/docs/index.rst b/docs/index.rst index fe071922f..0beee87c7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,40 +1,44 @@ .. _swh-storage: -Software Heritage - Development Documentation -============================================= +Software Heritage - Storage +=========================== + +Abstraction layer over the archive, allowing to access all stored source code +artifacts as well as their metadata + .. toctree:: :maxdepth: 2 :caption: Contents: The Software Heritage storage consist of a high-level storage layer (:mod:`swh.storage`) that exposes a client/server API (:mod:`swh.storage.api`). The API is exposed by a server (:mod:`swh.storage.api.server`) and accessible via a client (:mod:`swh.storage.api.client`). The low-level implementation of the storage is split between an object storage (:ref:`swh.objstorage `), which stores all "blobs" (i.e., the leaves of the :ref:`data-model`) and a SQL representation of the rest of the graph (:mod:`swh.storage.storage`). Database schema --------------- * :ref:`sql-storage` Archive copies -------------- * :ref:`archive-copies` Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`