feat(docs): move settings from sheet to workbook (#970)

* feat(docs): remove settings from sheet and add on workbook
FlatFilers · Dec 7, 2023 · 6006567 · 6006567
1 parent 99a57ea
commit 6006567
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 13 deletions.
diff --git a/_snippets/shared/embedded_listener_basicreact.mdx b/_snippets/shared/embedded_listener_basicreact.mdx
@@ -11,10 +11,7 @@ Next time you open Flatfile, you'll see a Workbook called "Contacts" that has on
 ```ts src/workbook.ts
 import { Flatfile } from "@flatfile/api";
 
-export const workbook: Pick<
-  Flatfile.CreateWorkbookConfig,
-  "name" | "labels" | "sheets" | "actions"
-> = {
+export const workbook: Flatfile.CreateWorkbookConfig = {
   name: "All Data",
   labels: ["pinned"],
   sheets: [

diff --git a/blueprint/sheet-options.mdx b/blueprint/sheet-options.mdx
@@ -17,7 +17,6 @@ Sheets have some basic options that determine their behavior.
       "readOnly": false,
       "allowAdditionalFields": false,
       "access": ["add", "edit"],
-      "settings": {"trackChanges": true},
       "fields": [
         {
           "key": "code",
@@ -71,13 +70,6 @@ Sheets have some basic options that determine their behavior.
   access controls](./access).
 </ParamField>
 
-<ParamField path="settings" type="object">
-  <b id="settings">Options:</b>
-  <br />
-  `trackChanges: true`: Disables actions on Sheet and Workbook when there is a
-  commit that has not been completed (often when Hooks are running)
-</ParamField>
-
 <ParamField path="fields" type="array" required>
   This is where you define your Sheet's data schema. The collection of fields in
   your Sheet detemines the shape of data you wish to accept. Read more about

diff --git a/concepts/workbooks.mdx b/concepts/workbooks.mdx
@@ -52,6 +52,11 @@ Workbooks and Sheets can also contain Actions. Actions are developer-defined ope
 
 [Learn more about Actions](../guides/actions)
 
-#### `Labels` _array_
+#### `Settings` _object_
+`trackChanges: true`: Disables actions on Sheet and Workbook when there is a
+commit that has not been completed (often when Hooks are running)
+
+[Learn more about Blueprint](../blueprint)
 
+#### `Labels` _array_
 To have a workbook appear first in the sidebar, give it the label 'pinned' (it will even have a pin icon!). You can also add other custom labels to your workbooks as needed.