maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(tvix/docs): add mdbook-admonish

Browse source 
This provides a plugin for callouts.

It needs to have additional CSS file added to `book.toml`,
which can be (re-)generated by `mdbook-admonish install`.

See https://github.com/tommilligan/mdbook-admonish/issues/171#issuecomment-2009166079
for more context.

Use it by adding a warning one to the architecture document.

Change-Id: I75c9a33d00acb603c6da10d3f9ce3485731c1672
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11805
Tested-by: BuildkiteCI
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: yuka <yuka@yuka.dev>
This commit is contained in:
Florian Klink 2024-06-13 21:37:16 +03:00 • committed by clbot
parent 9d44da01ee
commit 4df3284dd0
5 changed files with 369 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
tvix/docs/src/architecture.md
View file

@ -21,6 +21,15 @@ gRPC. The rest of this document outlines the components.
### Coordinator
```admonish warning
Currently there's no separate coordinator. Most of the interaction between
store, builder and evaluator is done by library code living in the `tvix-glue`
crate (and `tvix-cli` is a user of it).
Keep in mind some of the statements below are outdated and neither reflect
reality nor desired design anymore.
```
*Purpose:* The coordinator (in the simplest case, the Tvix CLI tool)
oversees the flow of a build process and delegates tasks to the right
subcomponents. For example, if a user runs the equivalent of