From e90d268cac7902d4ef7e2e9ed8ed662917246083 Mon Sep 17 00:00:00 2001
From: Christopher Haine <chaine@hpe.com>
Date: Tue, 6 Sep 2022 18:22:35 +0200
Subject: [PATCH] index
---
docs/sphinx/index.rst | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst
index 5b1caa00..760f6365 100644
--- a/docs/sphinx/index.rst
+++ b/docs/sphinx/index.rst
@@ -7,8 +7,8 @@ Welcome to Maestro Core's documentation!
========================================
Maestro Core is a C library that does multi-threaded cross-application data
-transfer over high-speed interconnect using lightweight data wrappers named
-CDOs that include user metadata.
+transfer and inspection over high-speed interconnect, using lightweight data
+wrappers named CDOs that include user metadata.
A producer application using Maestro Core may offer data and metadata:
@@ -38,7 +38,7 @@ Which a consumer application may demand:
mstro_cdo_require(dst_handle);
mstro_cdo_demand(dst_handle);
-When :ref:`mstro_cdo_demand()<docs-demand>` returns, the data and metadata has
+When ``mstro_cdo_demand()`` returns, the data and metadata has
been transferred by Maestro Core from the producer and is locally available for
the consumer.
@@ -52,8 +52,10 @@ That's it for the introduction.
.. toctree::
:maxdepth: 2
+ showroom
started
essentials
+ tuning
stories
dev
--
GitLab