From 07a41c5fad65975341f0c4c2a909a4cbd1de871e Mon Sep 17 00:00:00 2001 From: Stefano Zacchiroli <zack@upsilon.cc> Date: Fri, 20 Nov 2020 14:28:17 +0100 Subject: [PATCH] design doc: fix Sphinx/MyST markup to avoid broken cross-package links Closes T2785 --- docs/design.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/design.md b/docs/design.md index ed8e952..672862c 100644 --- a/docs/design.md +++ b/docs/design.md @@ -1,18 +1,18 @@ # Software Heritage Filesystem (SwhFS) --- Design notes -The [Software Heritage](https://www.softwareheritage.org/) {ref}`data model -<data-model>` is +The [Software Heritage](https://www.softwareheritage.org/) +{ref}`data model <data-model>` is a [Direct Acyclic Graph](https://en.wikipedia.org/wiki/Directed_acyclic_graph) (DAG) with nodes of different types that correspond to source code artifacts such as directories, commits, etc. Using this [FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace) module (*SwhFS* for short) you can locally mount, and then navigate as a -filesystem, parts of the archive identified by {ref}`Software Heritage -identifiers <persistent-identifiers>` (SWHIDs). +filesystem, parts of the archive identified by +{ref}`Software Heritage identifiers <persistent-identifiers>` (SWHIDs). To retrieve information about the source code artifacts, SwhFS interacts over -the network with the Software Heritage archive via its {ref}`Web API -<swh-web-api-urls>`. +the network with the Software Heritage archive via its +{ref}`Web API <swh-web-api-urls>`. ## Architecture -- GitLab