diff --git a/website/docs/devguide.md b/website/docs/devguide.md index 4f7bc20d..4e86d1d5 100644 --- a/website/docs/devguide.md +++ b/website/docs/devguide.md @@ -11,7 +11,7 @@ We use GitHub's issue tracker. ## Caesar -[Caesar's](./caesar.md)'s source code is begins at the root level of the Git repository. +[Caesar's](./caesar)'s source code is begins at the root level of the Git repository. It is a [cargo workspace](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html) containing the main `caesar` crate and the `z3rro` crate. We try to use [rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) as much as possible to document how `caesar` works. diff --git a/website/docs/introduction.md b/website/docs/introduction.md index 50d3e701..bab30683 100644 --- a/website/docs/introduction.md +++ b/website/docs/introduction.md @@ -21,6 +21,6 @@ I am also happy to discuss anything via Zoom as well! Start with the [quick start guide](./getting-started/README.md)! -General things about the tool is documented in the [Caesar](./caesar.md) chapter. +General things about the tool is documented in the [Caesar](./caesar) chapter. We have a section on the [pGCL frontend](./pgcl.md). There is also a chapter on the [HeyVL language](heyvl/) and the [standard library](stdlib/). diff --git a/website/docs/pgcl.md b/website/docs/pgcl.md index d47f2386..6804a695 100644 --- a/website/docs/pgcl.md +++ b/website/docs/pgcl.md @@ -53,7 +53,7 @@ Verification with `caesar` requires the `--raw` command-line flag since these fi Instructions on how to (re-)generate these examples are located in [`pgcl/examples-heyvl/README.md`](https://github.com/moves-rwth/caesar/blob/master/pgcl/examples-heyvl/README.md). -To execute `caesar` with the generated HeyVL files, refer to the [benchmarks section of Caesar's documentation](./caesar.md#benchmarks). +To execute `caesar` with the generated HeyVL files, refer to the [benchmarks section of Caesar's documentation](./caesar/benchmarks.md). ## pGCL Syntax