Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): API docs stucture #2014

Merged
merged 3 commits into from
Sep 6, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/dapps/api/aztec_rpc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Wallets and AztecRPC
---
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/dapps/api/contract_deployment.md
PhilWindle marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Contract Deployment
---
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/dapps/api/contract_interaction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Contract Interaction
---
9 changes: 9 additions & 0 deletions docs/docs/dev_docs/dapps/api/main.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/dapps/tutorials/contract_deployment.md
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: let's number these ones so they show in order on the sidebar

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't that defined by the positioning within sidebars.js?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, my bad!

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Contract Deployment
---
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/dapps/tutorials/contract_interaction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Contract Interaction
---
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/dapps/tutorials/creating_accounts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Creating Accounts
---
12 changes: 12 additions & 0 deletions docs/docs/dev_docs/dapps/tutorials/main.md
Original file line number Diff line number Diff line change
@@ -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
PhilWindle marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/dapps/tutorials/querying_state.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Querying State and Retrieving Logs
---
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/dapps/tutorials/rpc_server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Connecting to the RPC Server
---
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/dapps/tutorials/transactions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Simulating and sending transactions
---