From 9513bb56532d8380f59ba8b9c680f50101b3d8ba Mon Sep 17 00:00:00 2001 From: kjuulh Date: Fri, 10 Mar 2023 23:46:12 +0100 Subject: [PATCH] docs: add architecture --- ARCHITECTURE.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 ARCHITECTURE.md diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md new file mode 100644 index 0000000..24b1399 --- /dev/null +++ b/ARCHITECTURE.md @@ -0,0 +1,12 @@ +# Architecture + +- `.` Root project mainly used for generating the CLI, which in turn is used to + bootstrap the code generation from `dagger` +- `crates/dagger-core` Contains all base types used during actual usage. This is + where the primary logic lives in which the user interacts (\*disclaimer: most + stuff haven't moved in here yet.) +- `crates/dagger-sdk` Contains the actual sdk in which the user interacts, + `dagger-core` is reexported through this API as well. +- `crates/dagger-codegen` This is the bulk of the work, it takes the input + graphql and spits out the API in which the user interacts, this is heavily + inspired by other `dagger-sdk's`. It primarily turns graphql into rust code.