[themes] add usage instruction for themes (#152)

* docs: add usage instruction for themes * fix: add changelogs --------- Co-authored-by: Rohan Bansal <[email protected]>
agritheory · Sep 26, 2024 · 5558adc · 5558adc
1 parent f0d481d
commit 5558adc
Show file tree

Hide file tree

Showing 7 changed files with 766 additions and 955 deletions.
diff --git a/README.md b/README.md
@@ -1,18 +1,20 @@
-# STONECROP
+# Stonecrop
 
-This repository contains all the packages used in the Sedum project. It is managed with [Rush](rushjs.io).
+![Test Status](https://github.com/agritheory/stonecrop/actions/workflows/tests.yml/badge.svg) ![Lint Status](https://github.com/agritheory/stonecrop/actions/workflows/lint.yml/badge.svg)
 
-## What is it?
+This repository contains all the packages used in the Stonecrop project. It is managed with [Rush](https://rushjs.io).
+
+### What is it?
 
 These packages in combination create an application that creates a schema driven UI and system of event driven hooks (actual hooks, not the React kind which are not hooks at all). These are available in both the UI and as server middleware.
 
-## Getting Started
+### Getting Started
 
 This project has the following system dependencies:
 
 - [`pnpm`](https://pnpm.io/) (using yarn or npm will break packages)
 - [`rush`](https://rushjs.io/)
-- `nvm` and `node v20`: `nvm install 20 --lts && nvm use 20 --lts`
+- Node v20 LTS ([installation instructions](https://nodejs.org/en/download/package-manager))
 
 ```bash
 git clone stonecrop
@@ -24,9 +26,8 @@ cd stonecrop
 rush update
 rush rebuild
 
-# Work on stonecrop, for example
-cd stonecrop
-rushx story:dev
+# Work on aform, for example
+cd aform
 
 # sometimes, when changing branches or updating dependencies you may have issues
 # this command removes and re-links all dependencies
@@ -38,3 +39,16 @@ rush change
 # Stage changes and run linters
 rushx lint
 ```
+
+### Projects
+
+- [`@stonecrop/aform`](./aform/CHANGELOG.md)
+- [`@stonecrop/atable`](./atable/README.md)
+- [`@stonecrop/beam`](./beam/README.md)
+- [`@stonecrop/code_editor`](./code_editor/CHANGELOG.md)
+- [`@stonecrop/desktop`](./desktop/README.md)
+- [`@stonecrop/graphql_client`](./graphql_client/README.md)
+- [`@stonecrop/node_editor`](./node_editor/README.md)
+- [`@stonecrop/stonecrop`](./stonecrop/README.md)
+- [`@stonecrop/themes`](./themes/README.md)
+- [`@stonecrop/utilities`](./utilities/README.md)
diff --git a/common/changes/@stonecrop/stonecrop/docs-themes-usage_2024-09-19-06-33.json b/common/changes/@stonecrop/stonecrop/docs-themes-usage_2024-09-19-06-33.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@stonecrop/stonecrop",
+      "comment": "rename readme file",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@stonecrop/stonecrop"
+}
diff --git a/common/changes/@stonecrop/themes/docs-themes-usage_2024-09-19-06-33.json b/common/changes/@stonecrop/themes/docs-themes-usage_2024-09-19-06-33.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@stonecrop/themes",
+      "comment": "add docs to use styles",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@stonecrop/themes"
+}