From 5873e65d4d4b12d60314bd558f4871b6adc40c33 Mon Sep 17 00:00:00 2001 From: Aria Minaei Date: Tue, 5 Oct 2021 12:22:43 +0200 Subject: [PATCH] More docs --- packages/dataverse-experiments/README.md | 5 +++++ packages/dataverse/README.md | 5 +++++ packages/playground/README.md | 12 ++++++++++++ packages/r3f/README.md | 2 +- packages/react/README.md | 9 +++++++++ 5 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 packages/dataverse-experiments/README.md create mode 100644 packages/playground/README.md create mode 100644 packages/react/README.md diff --git a/packages/dataverse-experiments/README.md b/packages/dataverse-experiments/README.md new file mode 100644 index 0000000..9768060 --- /dev/null +++ b/packages/dataverse-experiments/README.md @@ -0,0 +1,5 @@ +# Dataverse experiments + +This package contains some experiments in [@theatre/dataverse](../dataverse). We are keeping these experiments in the main branch so they don't bitrot. + +The experimental `AbstractDerivation` in this package uses some ideas from [incremental](https://github.com/janestreet/incremental/blob/master/src/incremental_intf.ml). \ No newline at end of file diff --git a/packages/dataverse/README.md b/packages/dataverse/README.md index 0d3825e..164f4e3 100644 --- a/packages/dataverse/README.md +++ b/packages/dataverse/README.md @@ -4,3 +4,8 @@ Dataverse is the reactive dataflow library [Theatre.js](https://www.theatrejs.co Dataverse is currently an internal library. It is used within Theatre.js, but its API is not exposed through Theatre. This is so that we can iterate on the reactive internals while keeping the public API stable. We plan to eventually have an LTS release, but for now, expect a high release cadence and API churn in dataverse while the API in Theatre.js remains stable. +## Documentation + +* API Docs: [docs.theatrejs.com/api/dataverse](https://docs.theatrejs.com/api/dataverse.html) +* Guide: TODO + diff --git a/packages/playground/README.md b/packages/playground/README.md new file mode 100644 index 0000000..cb81155 --- /dev/null +++ b/packages/playground/README.md @@ -0,0 +1,12 @@ +# The playground + +The playground is the quickest way to hack on the internals of Theatre. It uses a simple ESBuild config that builds all the related packages in one go, so whether you're changing `@theatre/core` or `@theatre/dataverse`, you can see the results immediately. + +## How to use + +Simply run `yarn run serve` in this folder to start the dev server. + +The first time you run `serve`, an `src/index.ts` file will be created. This file won't be comitted to the repo, so you're free to change it. + +There are some shared playgrounds in `src/shared` which are committed to ther epo. You can make your own playgrounds in `src/personal` which will be `.gitignore`d. + diff --git a/packages/r3f/README.md b/packages/r3f/README.md index 2b0e681..2beec91 100644 --- a/packages/r3f/README.md +++ b/packages/r3f/README.md @@ -4,4 +4,4 @@ A [Theatre.js](https://github.com/AriaMinaei/theatre) extension for [THREE.js](h ## Documentation -Docs and video tutorials are [here](https://docs.theatrejs.com/r3f/). \ No newline at end of file +Docs and video tutorials are [here](https://docs.theatrejs.com/extensions/r3f/). \ No newline at end of file diff --git a/packages/react/README.md b/packages/react/README.md new file mode 100644 index 0000000..0a2339f --- /dev/null +++ b/packages/react/README.md @@ -0,0 +1,9 @@ +# @theatre/react + +Utilities for using [Theatre.js](https://www.theatrejs.com) with React. + +## Documentation + +* API Docs: [docs.theatrejs.com/api/react](https://docs.theatrejs.com/api/react.html) +* Guide: TODO +