From b57af3eab979e7a19272c081dffd5e374890ae57 Mon Sep 17 00:00:00 2001
From: Jake Albaugh <jalbaugh@figma.com>
Date: Sun, 2 Jun 2024 17:51:43 -0500
Subject: [PATCH] beginning to document the scripts

---
 scripts/icons/README.md                            | 3 +++
 {src/stories => scripts/preview}/Figma.stories.tsx | 0
 scripts/preview/README.md                          | 5 +++++
 scripts/tokens/README.md                           | 3 +++
 4 files changed, 11 insertions(+)
 create mode 100644 scripts/icons/README.md
 rename {src/stories => scripts/preview}/Figma.stories.tsx (100%)
 create mode 100644 scripts/tokens/README.md

diff --git a/scripts/icons/README.md b/scripts/icons/README.md
new file mode 100644
index 0000000..16a7210
--- /dev/null
+++ b/scripts/icons/README.md
@@ -0,0 +1,3 @@
+# SDS Icon Generator
+
+This script goes to a file, finds a page, pulls out all the icons on that page and creates an index file, React component, and Figma Code Connect doc for each icon.
diff --git a/src/stories/Figma.stories.tsx b/scripts/preview/Figma.stories.tsx
similarity index 100%
rename from src/stories/Figma.stories.tsx
rename to scripts/preview/Figma.stories.tsx
diff --git a/scripts/preview/README.md b/scripts/preview/README.md
index e69de29..8c9548a 100644
--- a/scripts/preview/README.md
+++ b/scripts/preview/README.md
@@ -0,0 +1,5 @@
+# figma-pluin-component-preview
+
+This is a proof of concept for rendering self-hosted storybook instances inside of Figma.
+
+In this directory, there is a Figma storybook file that contains stories that map Figma props to Storybook params. This plugin attempts to render those stories in the Figma plugin iframe.
diff --git a/scripts/tokens/README.md b/scripts/tokens/README.md
new file mode 100644
index 0000000..56e5894
--- /dev/null
+++ b/scripts/tokens/README.md
@@ -0,0 +1,3 @@
+# SDS Token Generator
+
+This script converts all styles and variables into a theme css file with CSS custom properties. You must be on enterprise to run this throuh the REST API. If you are not, you can use these plugins to get the data for styles.json and tokens.json and then you can run the converter separately with the `--skip-rest-api` flag.