draft doc outline

zio · Sep 15, 2024 · 869e265 · 869e265
1 parent c1bdefd
commit 869e265
Show file tree

Hide file tree

Showing 11 changed files with 83 additions and 4 deletions.
diff --git a/docs/concepts/architecture.md b/docs/concepts/architecture.md
@@ -0,0 +1,8 @@
+---
+id: architecture
+title: "Architecture"
+---
+
+# Architecture
+
+TODO
diff --git a/docs/concepts/high-level-api.md b/docs/concepts/high-level-api.md
@@ -0,0 +1,7 @@
+---
+id: high-level-api
+title: "High Level API"
+---
+
+# High Level API
+TODO
diff --git a/docs/concepts/low-level-api.md b/docs/concepts/low-level-api.md
@@ -0,0 +1,7 @@
+---
+id: low-level-api
+title: "Low Level API"
+---
+
+# Low Level API
+TODO
diff --git a/docs/transactions.md → docs/concepts/transactions.md b/docs/transactions.md → docs/concepts/transactions.md
diff --git a/docs/cheat-sheet.md → docs/guides/cheat-sheet.md b/docs/cheat-sheet.md → docs/guides/cheat-sheet.md
diff --git a/docs/codec-customization.md → docs/guides/codec-customization.md b/docs/codec-customization.md → docs/guides/codec-customization.md
diff --git a/docs/getting-started.md → docs/guides/getting-started.md b/docs/getting-started.md → docs/guides/getting-started.md
diff --git a/docs/reference/attribute-value.md b/docs/reference/attribute-value.md
@@ -0,0 +1,10 @@
+---
+id: attribute-value
+title: "AttributeValue"
+---
+
+# AttributeValue
+
+TODO
+
+mention aliases
diff --git a/docs/reference/dynamodb-query.md b/docs/reference/dynamodb-query.md
@@ -0,0 +1,8 @@
+---
+id: dynamodb-query
+title: "DynamoDBQuery"
+---
+
+# DynamoDBQuery
+
+TODO
diff --git a/docs/reference/projection-expression.md b/docs/reference/projection-expression.md
@@ -0,0 +1,8 @@
+---
+id: projection-expression
+title: "ProjectionExpression"
+---
+
+# ProjectionExpression
+
+TODO
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -6,10 +6,41 @@ const sidebars = {
       collapsed: false,
       link: { type: "doc", id: "index" },
       items: [
-        "getting-started",
-        "cheat-sheet",
-        "codec-customization",
-        "transactions",
+        // Concepts
+        {
+          type: "category",
+          collapsed: false,
+          label: "Concepts",
+          items: [
+            "concepts/architecture",
+            "concepts/low-level-api",
+            "concepts/high-level-api",
+            "concepts/transactions",
+          ],
+
+        },
+        // Guides
+        {
+          type: "category",
+          collapsed: false,
+          label: "Guides",
+          items: [
+            "guides/getting-started",
+            "guides/cheat-sheet",
+            "guides/codec-customization"
+          ]
+        },
+        // Reference
+        {
+          type: "category",
+          collapsed: false,
+          label: "Reference",
+          items: [
+            "reference/dynamodb-query",
+            "reference/attribute-value",
+            "reference/projection-expression",
+          ]
+        }
       ]
     }
   ]