Update readmes

strudel-science · Jun 13, 2024 · 0be73b1 · 0be73b1
1 parent 291dc71
commit 0be73b1
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 185 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,10 @@
-:warning: ***This library is in early-stage development and is subject to change frequently. Check back soon for more updates!***
-
 # STRUDEL Kit (Beta)
 
 STRUDEL Kit is a React-based JavaScript library for building scientific UIs based on the STRUDEL Design System and Task Flows. Visit [strudel.science](https://strudel.science) for more information about the STRUDEL project.
 
 This library provides a suite of templates to implement UIs for various different task flows common to the scientific domain. The app is intended to be used as a starting point for building out a web app that includes one or more of the task flows provided.
 
-### [Browse the Docs](https://github.com/strudel-science/strudel-kit/tree/main/docs)
+### [Browse the Docs](https://strudel.science/strudel-kit/docs/)
 
 ## Quickstart
 

diff --git a/strudel-cli/README.md b/strudel-cli/README.md
@@ -1,187 +1,11 @@
-:warning: ***This library is in early-stage development. Check back soon for more updates!***
-
 # STRUDEL Command-Line Interface (Beta)
 
 The strudel-cli is a command-line tool for bootstrapping web applications based on the [STRUDEL Design System](https://strudel.science/). 
 
-#### How it Works
-
-1. Configure your app with a simple JSON configuration.
-2. Generate a base web app built with the STRUDEL stack and STRUDEL design system.
-3. Add task flows to your app using the [STRUDEL task flow templates](https://strudel.science/design-system/task-flows/overview/).
-4. Dive into the code and start customizing. After generating your app you are in full control.
-
-#### The Stack
-
-The strudel-cli generates your app using a pre-defined stack based on principles from the STRUDEL Design System.
-
-- [TypeScript](https://www.typescriptlang.org/)
-- [React](https://react.dev/)
-- [Material UI](https://mui.com/material-ui/getting-started/)
-- [React Router](https://reactrouter.com/en/main)
-- [Create React App](https://create-react-app.dev/)
-
-## User Quickstart
-
-### Prequisites
-
-Node.js and NPM must be installed to run the web applications you generate with strudel-cli. To check if you already have Node.js and NPM installed, open a terminal and run:
-
-```
-node --version
-npm --version
-```
-
-If both commands return a version number, you should be good to go. If not, you can download both tools together here: https://nodejs.org/en/download
-
-### Get Started
-
-Install the STRUDEL CLI tool:
-
-```
-pip install strudel-cli
-```
-
-Create a config file based on the [create-app config json](https://github.com/strudel-science/strudel-kit/blob/main/strudel-cli/CONFIGS.md#create-app-config-file):
-
-_my-app-config.json_
-```js
-{
-  "name": "my-strudel-app",
-  "appTitle": "My Science App"
-}
-```
-
-Create a base app:
-
-```
-strudel create-app --config my-app-config.json
-```
-
-Create a config file for a new task flow based on [one of the config examples](https://github.com/strudel-science/strudel-kit/blob/main/strudel-cli/CONFIGS.md#compare-data):
-
-_my-taskflow-config.json_
-```js
-{
-  "name": "my-taskflow",
-  "template": "compare-data",
-  "compareItem": "scenario",
-  "compareItemPlural": "scenarios",
-  "mainPageTitle": "Compare Data App",
-  "mainPageDescription": "Description of this app section",
-  "newItemPageTitle": "Compare Data App",
-  "newItemPageDescription": "Description of this app section",
-  "comparePageDescription": "Description of this app section"
-}
-```
-
-Go to the root directory of your new app:
-
-```
-cd my-app
-```
-
-Add the task flow to your app:
-
-```
-strudel add-taskflow --config ../my-taskflow-config.json
-```
-
-Install dependencies and start your app.
-
-```
-npm install
-npm start
-```
-
-Open [http://localhost:3000](http://localhost:3000) to view the app in the browser.
-
-Didn't work? Make sure you have [installed NPM and Node.JS](https://nodejs.org/en/download).
-
-## Commands
-
-### `strudel create-app`
-
-Creates the base scaffolding for a web app based on the STRUDEL design system.
-
-```
-strudel create-app <app-name> [OPTIONS]
-```
-
-#### Arguments
-
-- `<app-name>`: Name to use for the app's root directory (e.g. `my-app`). Must be a valid directory name. [required]
-
-#### Options
-
-- `--config`, `-c`: JSON configuration file to use to build the base app. See [CONFIGS.md](https://github.com/strudel-science/strudel-kit/blob/main/strudel-cli/CONFIGS.md) for how to format this file. If not supplied, you will be prompted on the command-line to give configuration values.
-- `--output-dir`, `-o`: Path to the directory where the app should be created. Defaults to current directory.
-- `--branch`, `-b`: Branch in strudel-kit repo that should be used for the templates. Defaults to `main`. This option is primarily for use by contributors.
-
-### `strudel add-taskflow`
-
-Adds a new task flow to an existing strudel app. Give the task flow a name and choose one of the strudel task flow templates to base your section on.
-
-```
-strudel add-taskflow <taskflow-name> --template <taskflow-template> [OPTIONS]
-```
-
-#### Arguments
-
-- `<taskflow-name>`: Name to use for the task flow's root directory (e.g. `my-taskflow`). Must be a valid directory name. [required]
-
-#### Options
-
-- `--template`, `-t`: Name of the strudel task flow template to use to scaffold the task flow. [required]
-  - Available options: `compare-data`, `contribute-data`, `explore-data`, `monitor-activities`, `run-computation`, `search-data-repositories`
--  `--config`, `-c`: JSON configuration file to use to build the task flow. See [CONFIGS.md](https://github.com/strudel-science/strudel-kit/blob/main/strudel-cli/CONFIGS.md) for how to format this file. If not supplied, you will be prompted on the command-line to give configuration values.
-- `--output-dir`, `-o`: Path to the directory where the task flow should be created. Defaults to `src/apps`.
-- `--branch`, `-b`: Branch in strudel-kit repo that should be used for the templates. Defaults to `main`. This option is primarily for use by contributors.
-
-## Developer Quickstart
-
-### Install
-
-Clone the strudel-kit repo:
-
-```
-git clone [email protected]:strudel-science/strudel-kit.git
-```
-
-Navigate to the strudel-cli package of the strudel-kit repo:
-
-```
-cd strudel-kit/strudel-cli
-```
-
-(Recommended) Create a new conda environment or venv with python 3.9.6+ and activate it:
-
-```
-conda create strudel-env python=3.9
-conda activate strudel-env
-```
-
-Install the package in editable mode:
-
-```
-pip install -e .
-```
-
-Run the strudel commands:
-
-```
-strudel create-app <app-name> [OPTIONS]
-```
-
-### Testing
-
-From the strudel-cli directory, run:
-
-```
-pytest
-```
-
-All the tests live in `strudel-cli/tests`
+- [Installation](https://strudel.science/strudel-kit/docs/getting-started/installation)
+- [First Steps](https://strudel.science/strudel-kit/docs/getting-started/first-steps)
+- [API Reference](https://strudel.science/strudel-kit/docs/cli/reference)
+- [Quickstart](https://strudel.science/strudel-kit/docs/getting-started/quickstart)
 
 ### Publishing
 

diff --git a/strudel-taskflows/README.md b/strudel-taskflows/README.md
@@ -1,5 +1,3 @@
-:warning: ***This library is in early-stage development. Check back soon for more updates!***
-
 # STRUDEL Kit
 
 STRUDEL Kit is a React-based JavaScript library for building scientific UIs based on the STRUDEL Design System and Task Flows. Visit [strudel.science](https://strudel.science) for more information about the STRUDEL project.