diff options
| author | Florian Klink <flokli@flokli.de> | 2024-06-13T18·37+0300 |
|---|---|---|
| committer | clbot <clbot@tvl.fyi> | 2024-06-14T07·04+0000 |
| commit | 4df3284dd0766599148a4a34df59441e9d4dfe70 (patch) | |
| tree | de9edf6d94073eb2feb3cd2089c562eff6e39546 /tvix/docs/src | |
| parent | 9d44da01ee4b889db26681a1f86922f3a5839f0c (diff) | |
feat(tvix/docs): add mdbook-admonish r/8267
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>
Diffstat (limited to 'tvix/docs/src')
| -rw-r--r-- | tvix/docs/src/architecture.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/tvix/docs/src/architecture.md b/tvix/docs/src/architecture.md index 5e0aa95f1a08..02ffdfdcd2b0 100644 --- a/tvix/docs/src/architecture.md +++ b/tvix/docs/src/architecture.md @@ -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 |