mirrors/salsa
1
0
Fork 0
mirror of https://github.com/salsa-rs/salsa.git synced 2025-01-22 21:05:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

add a caveat to avoid confusion

Browse source
This commit is contained in:
Niko Matsakis 2022-08-02 06:36:17 +03:00
parent e3769b5c31
commit 5aabd4014d
3 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
book/src/caveat.md Normal file
View file

@ -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.

2
book/src/overview.md
View file

@ -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

2
book/src/tutorial.md
View file

@ -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.