From 869e265875d7e5dbe4959dbecc853d5566e91147 Mon Sep 17 00:00:00 2001 From: Avinder Bahra Date: Sun, 15 Sep 2024 09:37:50 +0100 Subject: [PATCH] draft doc outline --- docs/concepts/architecture.md | 8 +++++ docs/concepts/high-level-api.md | 7 +++++ docs/concepts/low-level-api.md | 7 +++++ docs/{ => concepts}/transactions.md | 0 docs/{ => guides}/cheat-sheet.md | 0 docs/{ => guides}/codec-customization.md | 0 docs/{ => guides}/getting-started.md | 0 docs/reference/attribute-value.md | 10 ++++++ docs/reference/dynamodb-query.md | 8 +++++ docs/reference/projection-expression.md | 8 +++++ docs/sidebars.js | 39 +++++++++++++++++++++--- 11 files changed, 83 insertions(+), 4 deletions(-) create mode 100644 docs/concepts/architecture.md create mode 100644 docs/concepts/high-level-api.md create mode 100644 docs/concepts/low-level-api.md rename docs/{ => concepts}/transactions.md (100%) rename docs/{ => guides}/cheat-sheet.md (100%) rename docs/{ => guides}/codec-customization.md (100%) rename docs/{ => guides}/getting-started.md (100%) create mode 100644 docs/reference/attribute-value.md create mode 100644 docs/reference/dynamodb-query.md create mode 100644 docs/reference/projection-expression.md diff --git a/docs/concepts/architecture.md b/docs/concepts/architecture.md new file mode 100644 index 00000000..dc52000f --- /dev/null +++ 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 new file mode 100644 index 00000000..24644ae3 --- /dev/null +++ b/docs/concepts/high-level-api.md @@ -0,0 +1,7 @@ +--- +id: high-level-api +title: "High Level API" +--- + +# High Level API +TODO \ No newline at end of file diff --git a/docs/concepts/low-level-api.md b/docs/concepts/low-level-api.md new file mode 100644 index 00000000..acf67bb5 --- /dev/null +++ b/docs/concepts/low-level-api.md @@ -0,0 +1,7 @@ +--- +id: low-level-api +title: "Low Level API" +--- + +# Low Level API +TODO \ No newline at end of file diff --git a/docs/transactions.md b/docs/concepts/transactions.md similarity index 100% rename from docs/transactions.md rename to docs/concepts/transactions.md diff --git a/docs/cheat-sheet.md b/docs/guides/cheat-sheet.md similarity index 100% rename from docs/cheat-sheet.md rename to docs/guides/cheat-sheet.md diff --git a/docs/codec-customization.md b/docs/guides/codec-customization.md similarity index 100% rename from docs/codec-customization.md rename to docs/guides/codec-customization.md diff --git a/docs/getting-started.md b/docs/guides/getting-started.md similarity index 100% rename from docs/getting-started.md rename to docs/guides/getting-started.md diff --git a/docs/reference/attribute-value.md b/docs/reference/attribute-value.md new file mode 100644 index 00000000..192c334a --- /dev/null +++ b/docs/reference/attribute-value.md @@ -0,0 +1,10 @@ +--- +id: attribute-value +title: "AttributeValue" +--- + +# AttributeValue + +TODO + +mention aliases \ No newline at end of file diff --git a/docs/reference/dynamodb-query.md b/docs/reference/dynamodb-query.md new file mode 100644 index 00000000..dd8aaa97 --- /dev/null +++ b/docs/reference/dynamodb-query.md @@ -0,0 +1,8 @@ +--- +id: dynamodb-query +title: "DynamoDBQuery" +--- + +# DynamoDBQuery + +TODO \ No newline at end of file diff --git a/docs/reference/projection-expression.md b/docs/reference/projection-expression.md new file mode 100644 index 00000000..832fcd94 --- /dev/null +++ b/docs/reference/projection-expression.md @@ -0,0 +1,8 @@ +--- +id: projection-expression +title: "ProjectionExpression" +--- + +# ProjectionExpression + +TODO \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index 318f81e1..a8ad380f 100644 --- 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", + ] + } ] } ]