[Tracking Issue] Docs

[iAmMichaelConnor]

Docs tracking

These tasklists list pages of the docs. If you'd like to work on a page:

• Convert the 'draft' tasklist row into a proper GitHub issue.
• Assign that issue to yourself.

Refer to sidebar.js for the current ordering of the pages, when they're built by docusaurus.

If you want to create new pages / split a page / or consolidate pages into one, that's probably fine - let's have a quick chat about it.

If you're not sure what should go on a page:

• Take a look at the current content of the page. There might be a short placeholder blurb, summarising what should go there
• If there isn't anything there, or if you still have doubts, let's chat - we might have got the suggested page titles slightly wrong.

Remember: there's a macro for injecting code from the codebase as code snippets into your docs. See docs/README.md for details.

Note: if you're writing a 'how to' guide (providing a recipe of step-by-step instructions), please consider using the TUTORIAL_TEMPLATE.md.

docs/dev-docs/getting_started

See here

Fast, and to-the-point. Instructions for getting a dev installed and using the software asap, with no friction.
Leave most detail for the more-detailed versions of these pages elsewhere in the docs.

docs/dev-docs/getting_started

Beta Give feedback

1. main
2. noir (just point to the noir docs)
3. noir_contracts in getting started page #1699
   documentation +1
   
4. docs/dev-docs/getting_started/sandbox #1492
   +0
   
5. docs/dev-docs/getting_started/cli #1493
   documentation +1
   
6. docs/dev-docs/getting_started/starter_kit #2172
   documentation +1
   

docs/dev-docs/contracts/

See here

See the Solidity docs to understand why the pages have been split in this way, and for inspiration about the tone of these pages.

docs/dev-docs/contracts

Beta Give feedback

1. docs/dev-docs/contracts/main
2. docs/dev-docs/contracts/syntax
3. docs/dev-docs/contracts/contract
4. docs/dev-docs/contracts/layout
5. docs/dev-docs/contracts/types
6. docs/dev-docs/contracts/storage #1610
   documentation +1
   
7. docs/dev-docs/contracts/state_variables #1509
   documentation +1
   
8. docs/dev-docs/contracts/functions #1609
   documentation +1
   
9. docs/dev-docs/contracts/circuit_abis <-- explain the public inputs of a private/public circuit
10. docs/dev-docs/contracts/artifacts <-- explain the artifacts json file #2190
    documentation +1
    
11. docs/dev-docs/contracts/control_structure
12. docs/dev-docs/contracts/visibility
13. docs/dev-docs/contracts/globals #2064
    +0
    
14. docs/dev-docs/contracts/events #1756
    +0
    
15. docs/dev-docs/contracts/constrain
16. compiling #1569
    documentation +1
    
17. deploying contracts using aztec-cli #1591
    documentation +1
    
18. Common contract errors #2468
    documentation +1
    
19. Writing docs for portal contracts #1439
    documentation +1
    
20. Document how to deploy contracts using aztec.js #1608
    +0
    
21. docs/dev-docs/contracts/context #2063
    +0

docs/dev-docs/contracts/resources

See here

These pages should give opinionated examples of patterns we'd like to see.
If you can think of other patterns that you've encountered so far, please add pages :)

docs/dev-docs/contracts/resources

Beta Give feedback

1. docs/dev-docs/contracts/resources/main
2. docs/dev-docs/contracts/resources/style_guide
3. docs/dev-docs/contracts/resources/common_patterns/main
4. docs/dev-docs/contracts/resources/common_patterns/sending_tokens_to_user
5. docs/dev-docs/contracts/resources/common_patterns/sending_tokens_to_contract
6. docs/dev-docs/contracts/resources/common_patterns/access_control
7. docs/dev-docs/contracts/resources/common_patterns/interacting_with_l1 #2264
   +0

docs/dev-docs/dapps

See here. Lots of questions listed here, for inspiration. Should covers aztec.js, e2e test examples, and generally how to write a javascript dapp. There's a big list of suggested content at this link. You might need wish to split it into many pages.

docs/dev-docs/dapps

Beta Give feedback

1. docs/dev-docs/dapps/main #1972
   documentation +1
   
2. docs/dev-docs/dapps/api/aztec_rpc #2044
   documentation +1
   
3. docs/dev-docs/dapps/api/main #2045
   documentation +1
   
4. docs/dev-docs/dapps/api/contract_interaction #2046
   documentation +1
   
5. docs/dev_docs/dapps/tutorials/main #2047
   +0
   
6. docs/dev_docs/dapps/tutorials/rpc_server #2048
   +0
   
7. docs/dev_docs/dapps/tutorials/creating_accounts #2049
   +0
   
8. docs/dev_docs/dapps/tutorials/contract_deployment #2050
   +0
   
9. docs/dev_docs/dapps/tutorials/contract_interaction #2051
   +0
   

docs/dev-docs/sandbox

See here. Lots of questions listed here, for inspiration. There's a big list of suggested content at this link. You might need want to split it into many pages. Feel free to modify the page layout as you please.

docs/dev-docs/sandbox

Beta Give feedback

1. docs/dev-docs/sandbox/main #1494
   +0
   
2. common errors (note: we might want to split this into pages, depending on how big it gets). Could this be automated, somehow? Could this file import the error names as code snippets directly from the source code, so they don't fall out of date?

docs/dev-docs/cli

See here. Lots of questions listed here, for inspiration. There's a big list of suggested content at this link. You might need want to split it into many pages. Feel free to modify the page layout as you please.

docs/dev-docs/cli

Beta Give feedback

1. docs/dev-docs/cli/main #1495
   documentation +1
   

docs/dev-docs/wallets

See here.

One of the key early users of the sandbox will be teams who wish to create wallet software for Aztec. We should write some beautiful explanations tailored towards this use case.
Feel free to modify the page layout as you please.

docs/dev-docs/wallets

Beta Give feedback

1. main #1741
   documentation +1
   
2. building_a_wallet #1745
   documentation +1
   
3. writing_an_account_contract #1744
   documentation +1
   

See here.

docs/dev-docs/testing

Beta Give feedback

1. docs/dev-docs/testing/main.md #2168
   documentation +1
2. docs/dev-docs/testing/writing_a_test.md - writing a test using aztec.js

TODO: tasklists for the other sections. We've only got tasklists for the dev-docs pages so far.

Foundational Concepts

Beta Give feedback

1. State Model
2. Transactions
3. Blocks
4. Types of entities (sequencer, prover, node)

[iAmMichaelConnor]

Closing this issue, in favour of devrel deciding how best to track issues for the docs, going forward. cc @critesjosh @catmcgee @rahul-kothari