chore(docs): API docs stucture (#2014)

This PR provides some structure for further api docs. # Checklist: Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge. - [ ] If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag. - [ ] I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code. - [ ] Every change is related to the PR description. - [ ] I have [linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this pull request to relevant issues (if any exist).
AztecProtocol · Sep 6, 2023 · 9aab9dd · 9aab9dd
1 parent 0c10958
commit 9aab9dd
Show file tree

Hide file tree

Showing 9 changed files with 73 additions and 0 deletions.
diff --git a/docs/docs/dev_docs/dapps/api/aztec_rpc.md b/docs/docs/dev_docs/dapps/api/aztec_rpc.md
@@ -0,0 +1,3 @@
+---
+title: Wallets and AztecRPC
+---
diff --git a/docs/docs/dev_docs/dapps/api/contract_interaction.md b/docs/docs/dev_docs/dapps/api/contract_interaction.md
@@ -0,0 +1,3 @@
+---
+title: Contract Interaction
+---
diff --git a/docs/docs/dev_docs/dapps/api/main.md b/docs/docs/dev_docs/dapps/api/main.md
@@ -0,0 +1,9 @@
+---
+title: API
+---
+
+## API Structure
+
+- Discuss AztecRPC, it's purpose and what it's used for
+- Discuss aztec.js and the generated typescript interfaces
+- Links to other pages within this api section
diff --git a/docs/docs/dev_docs/dapps/tutorials/contract_deployment.md b/docs/docs/dev_docs/dapps/tutorials/contract_deployment.md
@@ -0,0 +1,3 @@
+---
+title: Contract Deployment
+---
diff --git a/docs/docs/dev_docs/dapps/tutorials/contract_interaction.md b/docs/docs/dev_docs/dapps/tutorials/contract_interaction.md
@@ -0,0 +1,3 @@
+---
+title: Contract Interactions
+---
diff --git a/docs/docs/dev_docs/dapps/tutorials/creating_accounts.md b/docs/docs/dev_docs/dapps/tutorials/creating_accounts.md
@@ -0,0 +1,3 @@
+---
+title: Creating Accounts
+---
diff --git a/docs/docs/dev_docs/dapps/tutorials/main.md b/docs/docs/dev_docs/dapps/tutorials/main.md
@@ -0,0 +1,10 @@
+---
+title: Dapp Development Tutorials
+---
+
+Links to specific tutorials
+
+- Connecting to the RPC Server
+- Creating Accounts
+- Deploying a contract
+- Contract Interactions
diff --git a/docs/docs/dev_docs/dapps/tutorials/rpc_server.md b/docs/docs/dev_docs/dapps/tutorials/rpc_server.md
@@ -0,0 +1,3 @@
+---
+title: Connecting to the RPC Server
+---
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -157,6 +157,42 @@ const sidebars = {
         },
       ],
     },
+    {
+      label: "DApp Development",
+      type: "category",
+      link: {
+        type: "doc",
+        id: "dev_docs/dapps/main",
+      },
+      items: [
+        {
+          label: "API",
+          type: "category",
+          link: {
+            type: "doc",
+            id: "dev_docs/dapps/api/main",
+          },
+          items: [
+            "dev_docs/dapps/api/aztec_rpc",
+            "dev_docs/dapps/api/contract_interaction",
+          ],
+        },
+        {
+          label: "Tutorials",
+          type: "category",
+          link: {
+            type: "doc",
+            id: "dev_docs/dapps/tutorials/main",
+          },
+          items: [
+            "dev_docs/dapps/tutorials/rpc_server",
+            "dev_docs/dapps/tutorials/creating_accounts",
+            "dev_docs/dapps/tutorials/contract_deployment",
+            "dev_docs/dapps/tutorials/contract_interaction",
+          ],
+        },
+      ],
+    },
 
     {
       label: "Sandbox",