diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/architecture.md | 3 | ||||
| -rw-r--r-- | docs/lifecycle.md | 2 |
2 files changed, 3 insertions, 2 deletions
diff --git a/docs/architecture.md b/docs/architecture.md index 9edf086..8fc152f 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -163,7 +163,8 @@ Argon2), [`dashboard/`](../src/api/dashboard/) (with the `dashboard` feature: th come from [`remake/api.rs`](../src/remake/api.rs). [`docs/openapi.yaml`](openapi.yaml) describes it all; nodes serve it at `/openapi.yaml`, with a Swagger UI at `/swagger-ui`. -**Top level** — [`main.rs`](../src/main.rs) reads the configuration, picks the starting document and +**Top level** — continuum is a library: its `run` ([`lib.rs`](../src/lib.rs)), which the node's +binary ([`main.rs`](../src/main.rs)) calls, reads the configuration, picks the starting document and runs the shutdown sequence; [`node.rs`](../src/node.rs) builds a node's state and starts its workers (also used by the simulator); [`config/`](../src/config/) loads options from defaults, files and arguments ([`configuration.md`](configuration.md)); diff --git a/docs/lifecycle.md b/docs/lifecycle.md index e6ac31b..3140fa8 100644 --- a/docs/lifecycle.md +++ b/docs/lifecycle.md @@ -22,7 +22,7 @@ stateDiagram-v2 In the code there are two lifecycle states, `Joining` and `Ready` (`NodeLifecycle`); rejoining is `Joining` with the swarm ID kept, and starting and stopping are what -[`main.rs`](../src/main.rs) does before and after. The phases below are the operator's view. +`run` ([`lib.rs`](../src/lib.rs)) does before and after. The phases below are the operator's view. | Phase | Reads | Writes | Registers, votes, syncs as a source | Files written | |---|---|---|---|---| |
