From 5aabd4014d95dea2cd4c6f78845998cf03c64ad8 Mon Sep 17 00:00:00 2001 From: Niko Matsakis Date: Tue, 2 Aug 2022 06:36:17 +0300 Subject: [PATCH] add a caveat to avoid confusion --- book/src/caveat.md | 3 +++ book/src/overview.md | 2 ++ book/src/tutorial.md | 2 ++ 3 files changed, 7 insertions(+) create mode 100644 book/src/caveat.md diff --git a/book/src/caveat.md b/book/src/caveat.md new file mode 100644 index 00000000..df8f8c4c --- /dev/null +++ b/book/src/caveat.md @@ -0,0 +1,3 @@ +> ⚠️ **IN-PROGRESS VERSION OF SALSA.** ⚠️ +> +> This page describes the unreleased "Salsa 2022" version, which is a major departure from older versions of salsa. The code here works but is only available on github and from the `salsa-entity-mock` crate. diff --git a/book/src/overview.md b/book/src/overview.md index 5e50dd1f..fe281bc0 100644 --- a/book/src/overview.md +++ b/book/src/overview.md @@ -1,5 +1,7 @@ # Salsa overview +{{#include caveat.md}} + This page contains a brief overview of the pieces of a salsa program. For a more detailed look, check out the [tutorial](./tutorial.md), which walks through the creation of an entire project end-to-end. ## Database diff --git a/book/src/tutorial.md b/book/src/tutorial.md index b59c5471..b3439310 100644 --- a/book/src/tutorial.md +++ b/book/src/tutorial.md @@ -1,5 +1,7 @@ # Tutorial: calc +{{#include caveat.md}} + This tutorial walks through an end-to-end example of using Salsa. It does not assume you know anything about salsa, but reading the [overview](./overview.md) first is probably a good idea to get familiar with the basic concepts.