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

docs: initial 'protocol description' toc #2844

Merged
merged 1 commit into from
Oct 16, 2023
Merged

Conversation

iAmMichaelConnor
Copy link
Contributor

Just getting the ball rolling on "Describing the protocol".

I've set out a loose toc. It's more of a guide / reminder of topics at the moment. We'll rearrange as people start writing, I'm sure.

(I also kept the default 'docusaurus tutorial' around in a separate dir, because it might be a useful reference)

@iAmMichaelConnor iAmMichaelConnor added the A-documentation Area: relates to documentation label Oct 13, 2023
@iAmMichaelConnor iAmMichaelConnor enabled auto-merge (squash) October 13, 2023 14:21
@iAmMichaelConnor iAmMichaelConnor merged commit cb18f45 into master Oct 16, 2023
2 checks passed
@iAmMichaelConnor iAmMichaelConnor deleted the mc/paper-toc branch October 16, 2023 14:34
PhilWindle pushed a commit that referenced this pull request Oct 17, 2023
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.9.0</summary>

##
[0.9.0](aztec-packages-v0.8.14...aztec-packages-v0.9.0)
(2023-10-17)


### ⚠ BREAKING CHANGES

* nuking `PublicToken` and `PrivateAirdropToken`
([#2873](#2873))
* Change blake3 to blake2 in private kernel
([#2861](#2861))
* nuking private token
([#2822](#2822))

### Features

* Contract ts interface to use only aztec.js imports
([#2876](#2876))
([6952a1a](6952a1a))
* Faucet
([#2856](#2856))
([5bad35f](5bad35f))
* Nuking `PublicToken` and `PrivateAirdropToken`
([#2873](#2873))
([c74311d](c74311d))
* Nuking private token
([#2822](#2822))
([5d93a47](5d93a47)),
closes
[#2350](#2350)


### Bug Fixes

* Aztec node to save outbox adddress to config
([#2867](#2867))
([b6418a6](b6418a6))
* Create data dir on node boot
([#2864](#2864))
([2d498b3](2d498b3))
* Don't repeatedly scan for missing messages
([#2886](#2886))
([3fe1cc8](3fe1cc8))
* Fix trailing pipe causing everything to rebuild. Sorry...
([d13ba75](d13ba75))
* Pad L1 to L2 messages upon retrieval from L1
([#2879](#2879))
([457669e](457669e))
* Sequencer aborts in-progress block
([#2883](#2883))
([b0915a8](b0915a8))


### Miscellaneous

* Change blake3 to blake2 in private kernel
([#2861](#2861))
([d629940](d629940))
* Making anvil silent again
([#2866](#2866))
([90ae5dc](90ae5dc))
* Spell check on forbidden words.
([#2887](#2887))
([06bc4f9](06bc4f9))


### Documentation

* Initial 'protocol description' toc
([#2844](#2844))
([cb18f45](cb18f45))
</details>

<details><summary>barretenberg.js: 0.9.0</summary>

##
[0.9.0](barretenberg.js-v0.8.14...barretenberg.js-v0.9.0)
(2023-10-17)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>barretenberg: 0.9.0</summary>

##
[0.9.0](barretenberg-v0.8.14...barretenberg-v0.9.0)
(2023-10-17)


### Miscellaneous

* **barretenberg:** Synchronize aztec-packages versions
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
AztecBot added a commit to AztecProtocol/barretenberg that referenced this pull request Oct 18, 2023
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.9.0</summary>

##
[0.9.0](AztecProtocol/aztec-packages@aztec-packages-v0.8.14...aztec-packages-v0.9.0)
(2023-10-17)


### ⚠ BREAKING CHANGES

* nuking `PublicToken` and `PrivateAirdropToken`
([#2873](AztecProtocol/aztec-packages#2873))
* Change blake3 to blake2 in private kernel
([#2861](AztecProtocol/aztec-packages#2861))
* nuking private token
([#2822](AztecProtocol/aztec-packages#2822))

### Features

* Contract ts interface to use only aztec.js imports
([#2876](AztecProtocol/aztec-packages#2876))
([6952a1a](AztecProtocol/aztec-packages@6952a1a))
* Faucet
([#2856](AztecProtocol/aztec-packages#2856))
([5bad35f](AztecProtocol/aztec-packages@5bad35f))
* Nuking `PublicToken` and `PrivateAirdropToken`
([#2873](AztecProtocol/aztec-packages#2873))
([c74311d](AztecProtocol/aztec-packages@c74311d))
* Nuking private token
([#2822](AztecProtocol/aztec-packages#2822))
([5d93a47](AztecProtocol/aztec-packages@5d93a47)),
closes
[#2350](AztecProtocol/aztec-packages#2350)


### Bug Fixes

* Aztec node to save outbox adddress to config
([#2867](AztecProtocol/aztec-packages#2867))
([b6418a6](AztecProtocol/aztec-packages@b6418a6))
* Create data dir on node boot
([#2864](AztecProtocol/aztec-packages#2864))
([2d498b3](AztecProtocol/aztec-packages@2d498b3))
* Don't repeatedly scan for missing messages
([#2886](AztecProtocol/aztec-packages#2886))
([3fe1cc8](AztecProtocol/aztec-packages@3fe1cc8))
* Fix trailing pipe causing everything to rebuild. Sorry...
([d13ba75](AztecProtocol/aztec-packages@d13ba75))
* Pad L1 to L2 messages upon retrieval from L1
([#2879](AztecProtocol/aztec-packages#2879))
([457669e](AztecProtocol/aztec-packages@457669e))
* Sequencer aborts in-progress block
([#2883](AztecProtocol/aztec-packages#2883))
([b0915a8](AztecProtocol/aztec-packages@b0915a8))


### Miscellaneous

* Change blake3 to blake2 in private kernel
([#2861](AztecProtocol/aztec-packages#2861))
([d629940](AztecProtocol/aztec-packages@d629940))
* Making anvil silent again
([#2866](AztecProtocol/aztec-packages#2866))
([90ae5dc](AztecProtocol/aztec-packages@90ae5dc))
* Spell check on forbidden words.
([#2887](AztecProtocol/aztec-packages#2887))
([06bc4f9](AztecProtocol/aztec-packages@06bc4f9))


### Documentation

* Initial 'protocol description' toc
([#2844](AztecProtocol/aztec-packages#2844))
([cb18f45](AztecProtocol/aztec-packages@cb18f45))
</details>

<details><summary>barretenberg.js: 0.9.0</summary>

##
[0.9.0](AztecProtocol/aztec-packages@barretenberg.js-v0.8.14...barretenberg.js-v0.9.0)
(2023-10-17)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>barretenberg: 0.9.0</summary>

##
[0.9.0](AztecProtocol/aztec-packages@barretenberg-v0.8.14...barretenberg-v0.9.0)
(2023-10-17)


### Miscellaneous

* **barretenberg:** Synchronize aztec-packages versions
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: relates to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants