From 133cd409b957853cddbd9a89571d46e27adb1285 Mon Sep 17 00:00:00 2001 From: PhilWindle Date: Tue, 5 Sep 2023 14:24:38 +0000 Subject: [PATCH 1/3] API docs stucture --- docs/docs/dev_docs/dapps/api/aztec_rpc.md | 3 +++ docs/docs/dev_docs/dapps/api/contract_deployment.md | 3 +++ docs/docs/dev_docs/dapps/api/contract_interaction.md | 3 +++ docs/docs/dev_docs/dapps/api/main.md | 9 +++++++++ .../dev_docs/dapps/tutorials/contract_deployment.md | 3 +++ .../dev_docs/dapps/tutorials/contract_interaction.md | 3 +++ .../dev_docs/dapps/tutorials/creating_accounts.md | 3 +++ docs/docs/dev_docs/dapps/tutorials/main.md | 12 ++++++++++++ docs/docs/dev_docs/dapps/tutorials/querying_state.md | 3 +++ docs/docs/dev_docs/dapps/tutorials/rpc_server.md | 3 +++ docs/docs/dev_docs/dapps/tutorials/transactions.md | 3 +++ 11 files changed, 48 insertions(+) create mode 100644 docs/docs/dev_docs/dapps/api/aztec_rpc.md create mode 100644 docs/docs/dev_docs/dapps/api/contract_deployment.md create mode 100644 docs/docs/dev_docs/dapps/api/contract_interaction.md create mode 100644 docs/docs/dev_docs/dapps/api/main.md create mode 100644 docs/docs/dev_docs/dapps/tutorials/contract_deployment.md create mode 100644 docs/docs/dev_docs/dapps/tutorials/contract_interaction.md create mode 100644 docs/docs/dev_docs/dapps/tutorials/creating_accounts.md create mode 100644 docs/docs/dev_docs/dapps/tutorials/main.md create mode 100644 docs/docs/dev_docs/dapps/tutorials/querying_state.md create mode 100644 docs/docs/dev_docs/dapps/tutorials/rpc_server.md create mode 100644 docs/docs/dev_docs/dapps/tutorials/transactions.md diff --git a/docs/docs/dev_docs/dapps/api/aztec_rpc.md b/docs/docs/dev_docs/dapps/api/aztec_rpc.md new file mode 100644 index 00000000000..9107f2545ff --- /dev/null +++ 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_deployment.md b/docs/docs/dev_docs/dapps/api/contract_deployment.md new file mode 100644 index 00000000000..f695d4e0cb5 --- /dev/null +++ b/docs/docs/dev_docs/dapps/api/contract_deployment.md @@ -0,0 +1,3 @@ +--- +title: Contract Deployment +--- \ No newline at end of file diff --git a/docs/docs/dev_docs/dapps/api/contract_interaction.md b/docs/docs/dev_docs/dapps/api/contract_interaction.md new file mode 100644 index 00000000000..9bb0d573edd --- /dev/null +++ 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 new file mode 100644 index 00000000000..113cfa1d133 --- /dev/null +++ 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 new file mode 100644 index 00000000000..a2cc9d4f044 --- /dev/null +++ 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 new file mode 100644 index 00000000000..40ef4a2c56a --- /dev/null +++ b/docs/docs/dev_docs/dapps/tutorials/contract_interaction.md @@ -0,0 +1,3 @@ +--- +title: Contract Interaction +--- \ No newline at end of file diff --git a/docs/docs/dev_docs/dapps/tutorials/creating_accounts.md b/docs/docs/dev_docs/dapps/tutorials/creating_accounts.md new file mode 100644 index 00000000000..95e19162829 --- /dev/null +++ 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 new file mode 100644 index 00000000000..b9249f03f07 --- /dev/null +++ b/docs/docs/dev_docs/dapps/tutorials/main.md @@ -0,0 +1,12 @@ +--- +title: Dapp Development Tutorials +--- + +- Links to specific tutorials + +- Connecting to the RPC Server +- Creating Accounts +- Deploying a contract +- Contract Interaction and View methods +- Simulating and sending transactions +- Querying state and retrieving logs diff --git a/docs/docs/dev_docs/dapps/tutorials/querying_state.md b/docs/docs/dev_docs/dapps/tutorials/querying_state.md new file mode 100644 index 00000000000..f5aca31fc4c --- /dev/null +++ b/docs/docs/dev_docs/dapps/tutorials/querying_state.md @@ -0,0 +1,3 @@ +--- +title: Querying State and Retrieving Logs +--- diff --git a/docs/docs/dev_docs/dapps/tutorials/rpc_server.md b/docs/docs/dev_docs/dapps/tutorials/rpc_server.md new file mode 100644 index 00000000000..095f49b49ad --- /dev/null +++ b/docs/docs/dev_docs/dapps/tutorials/rpc_server.md @@ -0,0 +1,3 @@ +--- +title: Connecting to the RPC Server +--- diff --git a/docs/docs/dev_docs/dapps/tutorials/transactions.md b/docs/docs/dev_docs/dapps/tutorials/transactions.md new file mode 100644 index 00000000000..2f7f133589b --- /dev/null +++ b/docs/docs/dev_docs/dapps/tutorials/transactions.md @@ -0,0 +1,3 @@ +--- +title: Simulating and sending transactions +--- From a1d265079a2e80ee88e97b169ab6e3f9f5cc1f67 Mon Sep 17 00:00:00 2001 From: PhilWindle Date: Tue, 5 Sep 2023 16:32:32 +0000 Subject: [PATCH 2/3] Review changes --- docs/docs/dev_docs/dapps/api/contract_deployment.md | 3 --- docs/docs/dev_docs/dapps/tutorials/contract_interaction.md | 4 ++-- docs/docs/dev_docs/dapps/tutorials/main.md | 4 +--- docs/docs/dev_docs/dapps/tutorials/querying_state.md | 3 --- docs/docs/dev_docs/dapps/tutorials/transactions.md | 3 --- 5 files changed, 3 insertions(+), 14 deletions(-) delete mode 100644 docs/docs/dev_docs/dapps/api/contract_deployment.md delete mode 100644 docs/docs/dev_docs/dapps/tutorials/querying_state.md delete mode 100644 docs/docs/dev_docs/dapps/tutorials/transactions.md diff --git a/docs/docs/dev_docs/dapps/api/contract_deployment.md b/docs/docs/dev_docs/dapps/api/contract_deployment.md deleted file mode 100644 index f695d4e0cb5..00000000000 --- a/docs/docs/dev_docs/dapps/api/contract_deployment.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Contract Deployment ---- \ No newline at end of file diff --git a/docs/docs/dev_docs/dapps/tutorials/contract_interaction.md b/docs/docs/dev_docs/dapps/tutorials/contract_interaction.md index 40ef4a2c56a..ba0febbcfb8 100644 --- a/docs/docs/dev_docs/dapps/tutorials/contract_interaction.md +++ b/docs/docs/dev_docs/dapps/tutorials/contract_interaction.md @@ -1,3 +1,3 @@ --- -title: Contract Interaction ---- \ No newline at end of file +title: Contract Interactions +--- diff --git a/docs/docs/dev_docs/dapps/tutorials/main.md b/docs/docs/dev_docs/dapps/tutorials/main.md index b9249f03f07..278bba91f84 100644 --- a/docs/docs/dev_docs/dapps/tutorials/main.md +++ b/docs/docs/dev_docs/dapps/tutorials/main.md @@ -7,6 +7,4 @@ title: Dapp Development Tutorials - Connecting to the RPC Server - Creating Accounts - Deploying a contract -- Contract Interaction and View methods -- Simulating and sending transactions -- Querying state and retrieving logs +- Contract Interactions diff --git a/docs/docs/dev_docs/dapps/tutorials/querying_state.md b/docs/docs/dev_docs/dapps/tutorials/querying_state.md deleted file mode 100644 index f5aca31fc4c..00000000000 --- a/docs/docs/dev_docs/dapps/tutorials/querying_state.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Querying State and Retrieving Logs ---- diff --git a/docs/docs/dev_docs/dapps/tutorials/transactions.md b/docs/docs/dev_docs/dapps/tutorials/transactions.md deleted file mode 100644 index 2f7f133589b..00000000000 --- a/docs/docs/dev_docs/dapps/tutorials/transactions.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Simulating and sending transactions ---- From c92718f165ddadbb1163add80915cd90998785fb Mon Sep 17 00:00:00 2001 From: PhilWindle Date: Tue, 5 Sep 2023 16:51:00 +0000 Subject: [PATCH 3/3] WIP --- docs/docs/dev_docs/dapps/tutorials/main.md | 2 +- docs/sidebars.js | 36 ++++++++++++++++++++++ 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/docs/dev_docs/dapps/tutorials/main.md b/docs/docs/dev_docs/dapps/tutorials/main.md index 278bba91f84..957a8f9c10e 100644 --- a/docs/docs/dev_docs/dapps/tutorials/main.md +++ b/docs/docs/dev_docs/dapps/tutorials/main.md @@ -2,7 +2,7 @@ title: Dapp Development Tutorials --- -- Links to specific tutorials +Links to specific tutorials - Connecting to the RPC Server - Creating Accounts diff --git a/docs/sidebars.js b/docs/sidebars.js index eb329ca322f..5887860671d 100644 --- 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",