docs: turorial template

docs/docs/aztec/TUTORIAL-TEMPLATE.md

@@ -0,0 +1,112 @@
+<!--
+
+Hi there!
+
+This is a TEMPLATE for a "HOW TO DO SOMETHING" guide.
+
+-->
+
+<!--
+
+Here are some tips on writing style:
+
+For CONSISTENCY between authors, YOU MUST use this layout and these headings.
+
+The bulk of your explanations will go in the CUSTOM HEADING sections.
+
+
+
+Be very direct, like a RECIPE book.
+
+Not much prose. Prefer bullets, single sentences, copyable code snippets. Devs are lazy and don't want to read lots.
+
+Deeper PROTOCOL discussion (under the hood explanations / justifying your protocol decisions) should go in the [protocol](../../protocol/) section.
+
+Code snippets should be as minimal as possible. Get to the point. Remember, you can use #include_code syntax for code snippets (see the README.md)
+
+-->
+
+DESIGN CHOICES / KNOWN LIMITATIONS
+
+EXAMPLES SECTION
+
+## Introduction
+
+1-3 sentences explaning WHAT this guide is for.
+
+:::info Prerequisites
+If you haven't read [thing](), we recommend going there first.
+:::
+
+<!-- OR -->
+
+:::info Fast track
+Already familiar with ...? Jump to...
+<!-- AND / OR -->
+Don't want to read the docs? Install [beautifully packaged box which exemplifies this concept] [here]().
+:::
+
+### Aims
+
+The guide will cover:
+
+- ...
+- ...
+- ...
+
+At the end of the guide, you should be able to \< sentence explaining high level >
+
+### Why is this useful?
+
+<!-- Contextualise why a dapp developer needs this. What use cases / products / features does this unlock? Any real world examples? -->
+
+### Dependencies
+
+For this guide, the following Aztec packages are used:
+- [link]()
+- [link]()
+
+### Examples
+
+<!-- If applicable, link to example code. -->
+
+
+## CUSTOM HEADING 1
+
+<!-- This is the 'meat' of this document -->
+
+## CUSTOM HEADING 2
+
+
+## Known limitations
+
+:::warning Limitations
+<!--
+It's vital that we're honest and direct about:
+- Things which don't work yet
+- SECURITY LIMITATIONS
+- Knacks / hacks
+- Planned fixes / features.
+
+Please bullet-list anything you can think of here.
+-->
+:::
+
+
+## Participate
+
+<!-- TBC: link to boilerplate page on how to contribute / participate.  -->
+
+
+## Next steps
+
+<!-- 
+What should a dev read next?
+What should a dev build next?
+What can a dev try?
+-->
+
+
+<!-- IMPORT THE DISCLAIMER AT THE END (you'll need to make sure the path is correct) -->
+<!-- import Disclaimer from "./aztec/common/\_disclaimer.mdx";
+<Disclaimer/> -->

docs/docs/aztec/contributing-to-aztec/README.md

@@ -0,0 +1,5 @@
+# Goal of this dir
+
+Teach external people everything about the Aztec codebase.
+
+After reading this dir, a dev should be able to contribute to the `aztec-packages` codebase.

docs/docs/aztec/developer/README.md

@@ -0,0 +1,7 @@
+# Goal of this dir
+
+Teach dapp developers everything they need to write Aztec dapps.
+
+Teach wallet providers everything they need to write an Aztec wallet.
+
+Teach developers everything they need to use the Aztec Sandbox.

docs/docs/aztec/developer/dapps/building-dapps.md

@@ -4,6 +4,8 @@
 
 Explain how to write a dapp using [`aztec.js`](https://github.com/AztecProtocol/aztec-packages/tree/master/yarn-project/aztec.js). Maybe that readme is enough?
 
+Please use the [TUTORIAL-TEMPLATE](../../TUTORIAL-TEMPLATE.md) for standalone guides / tutorials.
+
 ## Deploying a contract
 
 Explain

docs/docs/aztec/developer/noir-contracts/compiling-contracts.md

@@ -1,5 +1,6 @@
 # Compiling contracts
 
+Please use the [TUTORIAL-TEMPLATE](../../TUTORIAL-TEMPLATE.md) for standalone guides / tutorials.
 ## Compiling a Noir Contract
 
 You can use the `master` branch of Noir/nargo (hooray).

docs/docs/aztec/developer/noir-contracts/getting-started.md

@@ -1,5 +1,7 @@
 # Getting started
 
+Please consider using the [TUTORIAL-TEMPLATE](../../TUTORIAL-TEMPLATE.md) for standalone guides / tutorials.
+
 ## Installing Noir
 
 To write a Noir Contract, you need to write Noir, and to write Noir, you need to [install Nargo](https://noir-lang.org/getting_started/nargo_installation).

docs/docs/aztec/developer/noir-contracts/testing-contracts.md

@@ -1,5 +1,7 @@
 # Testing contracts
 
+Please use the [TUTORIAL-TEMPLATE](../../TUTORIAL-TEMPLATE.md) for standalone guides / tutorials.
+
 ## Testing in Noir
 
 Individual functions can be tested much like [how 'regular Noir' functions can be tested](https://noir-lang.org/nargo/testing).

docs/docs/aztec/developer/portal-contracts/portal-contracts.md

@@ -1,5 +1,5 @@
 # Portal Contracts
 
-## What is a portal contract?
+<!-- Please focus on HOW to write, test, deploy, and interact with portal contracts, and how to test them in the context of an Aztec dapp. -->
 
-## How to write a portal contract
+Please use the [TUTORIAL-TEMPLATE](../../TUTORIAL-TEMPLATE.md) for standalone guides / tutorials.

docs/docs/aztec/developer/sandbox/sandbox.md

@@ -1,5 +1,8 @@
 # The Aztec Sandbox
 
+
+Please use the [TUTORIAL-TEMPLATE](../../TUTORIAL-TEMPLATE.md) for standalone guides / tutorials.
+
 ## Installing the sandbox
 
 <!-- Maybe we can just copy-paste / embed from the repo? -->

docs/docs/aztec/developer/wallet-providers/building-a-wallet.md

@@ -1,2 +1,3 @@
 # Building a wallet
 
+Please use the [TUTORIAL-TEMPLATE](../../TUTORIAL-TEMPLATE.md) for standalone guides / tutorials.

docs/docs/aztec/developer/wallet-providers/writing-an-account-contract.md

@@ -1,2 +1,3 @@
 # Writing an Account Contract
 
+Please use the [TUTORIAL-TEMPLATE](../../TUTORIAL-TEMPLATE.md) for standalone guides / tutorials.

docs/docs/aztec/protocol/README.md

@@ -0,0 +1,9 @@
+# Goal of this dir
+
+Describe the protocol.
+
+Justify protocol decisions.
+
+Outline outstanding features, and any problems with the protocol.
+
+Describe limitations of the protocol.