From ff1f8e8e84ee5dab4b82425e00786655598c4ee1 Mon Sep 17 00:00:00 2001 From: Ozzie Gooen Date: Sat, 23 Jul 2022 11:06:15 -0700 Subject: [PATCH] Several small documentation improvements --- packages/website/docs/Guides/Language.mdx | 41 ++++++++++++----------- packages/website/docs/Introduction.md | 14 +++++++- 2 files changed, 35 insertions(+), 20 deletions(-) diff --git a/packages/website/docs/Guides/Language.mdx b/packages/website/docs/Guides/Language.mdx index 3a195c1f..1bfe58e2 100644 --- a/packages/website/docs/Guides/Language.mdx +++ b/packages/website/docs/Guides/Language.mdx @@ -7,44 +7,47 @@ import { SquiggleEditor } from "../../src/components/SquiggleEditor"; ## Expressions -### Distributions - - - ### Numbers -### Arrays +### Distributions + + + +### Lists -### Records + + +### Dictionaries -## Statements - -A statement assigns expressions to names. It looks like ` = ` - - - ### Functions -We can define functions + + + +### Anonymous Functions ## See more diff --git a/packages/website/docs/Introduction.md b/packages/website/docs/Introduction.md index e04157c2..57c2ce36 100644 --- a/packages/website/docs/Introduction.md +++ b/packages/website/docs/Introduction.md @@ -3,7 +3,19 @@ sidebar_position: 1 title: Introduction --- -Squiggle is an _estimation language_, and a syntax for _calculating and expressing beliefs_ involving uncertainty. It has use cases in forecasting and writing evaluations. +Squiggle is a simple programming language for intuitive probabilistic estimation. It's meant for quantitative forecasting and evaluations. + +The basics of Squiggle can be pretty simple and intuitive. The more advanced functionality can take some time to learn. + +## What Squiggle Is +- A simple programming language for doing math with probability distributions +- An embeddable language that can be used in Javascript applications +- A tool to embed functions as forecasts that can be embedded in other applications + +## What Squiggle Is Not +- A complete replacement for enterprise Risk Analysis tools (See Crystal Ball, @Risk, Lumina Analytica) +- A Probabilistic Programming Language with backwards inference and sophisticated sampling algorithms. (See [PPLs](https://en.wikipedia.org/wiki/Probabilistic_programming)) +- A visual tool aimed at casual users (see Guesstimate, Causal) ## Get started