about summary refs log tree commit diff
path: root/tvix/docs
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2024-06-14T14·45+0300
committerflokli <flokli@flokli.de>2024-06-15T03·56+0000
commit6e321c615c74ed151124f677597e5e2d25e07431 (patch)
tree7c7019683b6c32c4560668fd03eee866c26ac184 /tvix/docs
parent46585bee1543123b2a64817eb7beace36af10436 (diff)
docs(tvix/*store): add some internal links r/8277
We can now cross-link between pages, and it actually works.

Change-Id: Id8bd85111672c687118db9adae7f5066f22441f5
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11817
Reviewed-by: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: Ilan Joselevich <personal@ilanjoselevich.com>
Diffstat (limited to 'tvix/docs')
-rw-r--r--tvix/docs/src/castore/blobstore-chunking.md2
-rw-r--r--tvix/docs/src/castore/blobstore-protocol.md4
-rw-r--r--tvix/docs/src/castore/data-model.md2
-rw-r--r--tvix/docs/src/store/api.md2
4 files changed, 5 insertions, 5 deletions
diff --git a/tvix/docs/src/castore/blobstore-chunking.md b/tvix/docs/src/castore/blobstore-chunking.md
index df3c29680257..d8c3d54b52f0 100644
--- a/tvix/docs/src/castore/blobstore-chunking.md
+++ b/tvix/docs/src/castore/blobstore-chunking.md
@@ -77,7 +77,7 @@ our data model / identifier upfront, but can make this mostly a transport/
 storage concern.
 
 For some more description on the (remote) protocol, check
-`./blobstore-protocol.md`.
+[BlobStore Protocol](./blobstore-protocol.md).
 
 #### Logical vs. physical chunking
 
diff --git a/tvix/docs/src/castore/blobstore-protocol.md b/tvix/docs/src/castore/blobstore-protocol.md
index 048cafc3d877..0dff787ccb00 100644
--- a/tvix/docs/src/castore/blobstore-protocol.md
+++ b/tvix/docs/src/castore/blobstore-protocol.md
@@ -41,7 +41,7 @@ It also puts very little requirements on someone implementing a new
 The gRPC protocol is documented in `../protos/rpc_blobstore.proto`.
 Contrary to the `BlobService` trait, it does not have any options for seeking/
 ranging, as it's more desirable to provide this through chunking (see also
-`./blobstore-chunking.md`).
+[BlobStore Chunking](./blobstore-chunking.md).
 
 ## Composition
 Different `BlobStore` are supposed to be "composed"/"layered" to express
@@ -76,7 +76,7 @@ an additional additional field in the response, which would allow clients to
 populate their local chunk store in a single roundtrip.
 
 ## Verified Streaming
-As already described in `./docs/blobstore-chunking.md`, the physical chunk
+As already described in [BlobStore Chunking](./blobstore-chunking.md), the physical chunk
 information sent in a `BlobService.Stat()` response is still sufficient to fetch
 in an authenticated fashion.
 
diff --git a/tvix/docs/src/castore/data-model.md b/tvix/docs/src/castore/data-model.md
index 5e6220cc23fa..7f7e396a2267 100644
--- a/tvix/docs/src/castore/data-model.md
+++ b/tvix/docs/src/castore/data-model.md
@@ -2,7 +2,7 @@
 
 This provides some more notes on the fields used in castore.proto.
 
-See `//tvix/store/docs/api.md` for the full context.
+See [Store API](../store/api.md) for the full context.
 
 ## Directory message
 `Directory` messages use the blake3 hash of their canonical protobuf
diff --git a/tvix/docs/src/store/api.md b/tvix/docs/src/store/api.md
index c5a5c477aa17..7812b1a6cb64 100644
--- a/tvix/docs/src/store/api.md
+++ b/tvix/docs/src/store/api.md
@@ -5,7 +5,7 @@ This document outlines the design of the API exposed by tvix-castore and tvix-
 store, as well as other implementations of this store protocol.
 
 This document is meant to be read side-by-side with
-[castore.md](../../castore/docs/data-model.md) which describes the data model
+[Data Model](../castore/data-model.md) which describes the data model
 in more detail.
 
 The store API has four main consumers: