Page Menu
Home
Software Heritage
Search
Configure Global Search
Log In
Files
F9749336
D1956.id.diff
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Flag For Later
Size
1 KB
Subscribers
None
D1956.id.diff
View Options
diff --git a/docs/api.rst b/docs/api.rst
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1,5 +1,5 @@
-Graph traversal API
-===================
+Traversal REST API
+==================
Terminology
-----------
diff --git a/docs/docker.rst b/docs/docker.rst
--- a/docs/docker.rst
+++ b/docs/docker.rst
@@ -1,5 +1,5 @@
-Graph Docker environment
-========================
+Docker environment
+==================
Build
diff --git a/docs/index.rst b/docs/index.rst
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,20 +7,12 @@
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 <compression>`
-* :doc:`Graph service REST API <api>`
-* :doc:`Use cases <use-cases>`
-* :doc:`Docker environment <docker>` (for development purposes)
-
-
-Reference Documentation
------------------------
-
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
+ :caption: Overview
+ compression
+ api
+ use-cases
+ docker
/apidoc/swh.graph
diff --git a/docs/use-cases.rst b/docs/use-cases.rst
--- a/docs/use-cases.rst
+++ b/docs/use-cases.rst
@@ -1,3 +1,8 @@
+=========
+Use cases
+=========
+
+
This document lists use cases and benchmark scenarios for the Software Heritage
graph service.
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Sun, Aug 24, 4:50 PM (1 w, 1 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3215788
Attached To
D1956: docs: fix toc
Event Timeline
Log In to Comment