-
Notifications
You must be signed in to change notification settings - Fork 213
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): Update proving backend related docs (#5601)
# Description ## Summary\* Update docs related to the installation and use of proving backends following #4960. Focusing mainly on improving: 1. Noir's proving backend agnosticity 2. Formatting/readability Best to merge this PR in before stable releasing v0.31.0 and v0.32.0. ## Documentation\* Check one: - [ ] No documentation needed. - [x] Documentation included in this PR. - [ ] **[For Experimental Features]** Documentation to be submitted in a separate PR. # PR Checklist\* - [x] I have tested the changes locally. - [x] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings. --------- Co-authored-by: James Zaki <[email protected]>
- Loading branch information
Showing
24 changed files
with
220 additions
and
255 deletions.
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
...ting_started/barretenberg/_category_.json → ...s/getting_started/backend/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"position": 1, | ||
"label": "Install Barretenberg", | ||
"label": "Install Proving Backend", | ||
"collapsible": true, | ||
"collapsed": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: Proving Backend Installation | ||
description: Proving backends offer command line tools for proving and verifying Noir programs. This page describes how to install `bb` as an example. | ||
keywords: [ | ||
Proving | ||
Backend | ||
Barretenberg | ||
bb | ||
bbup | ||
Installation | ||
Terminal | ||
Command | ||
CLI | ||
Version | ||
] | ||
pagination_next: getting_started/hello_noir/index | ||
--- | ||
|
||
Proving backends each provide their own tools for working with Noir programs, providing functionality like proof generation, proof verification, and verifier smart contract generation. | ||
|
||
For the latest information on tooling provided by each proving backend, installation instructions, Noir version compatibility... you may refer to the proving backends' own documentation. | ||
|
||
You can find the full list of proving backends compatible with Noir in [Awesome Noir](https://github.com/noir-lang/awesome-noir/?tab=readme-ov-file#proving-backends). | ||
|
||
## Example: Installing `bb` | ||
|
||
`bb` is the CLI tool provided by the [Barretenberg proving backend](https://github.com/AztecProtocol/barretenberg) developed by Aztec Labs. | ||
|
||
You can find the instructions for installation in [`bb`'s documentation](https://github.com/AztecProtocol/aztec-packages/blob/master/barretenberg/cpp/src/barretenberg/bb/readme.md#installation). | ||
|
||
Once installed, we are ready to start working on [our first Noir program](../hello_noir/index.md). |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ting_started/barretenberg/_category_.json → ...0/getting_started/backend/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"position": 1, | ||
"label": "Install Barretenberg", | ||
"label": "Install Proving Backend", | ||
"collapsible": true, | ||
"collapsed": true | ||
} |
31 changes: 31 additions & 0 deletions
31
docs/versioned_docs/version-v0.31.0/getting_started/backend/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: Proving Backend Installation | ||
description: Proving backends offer command line tools for proving and verifying Noir programs. This page describes how to install `bb` as an example. | ||
keywords: [ | ||
Proving | ||
Backend | ||
Barretenberg | ||
bb | ||
bbup | ||
Installation | ||
Terminal | ||
Command | ||
CLI | ||
Version | ||
] | ||
pagination_next: getting_started/hello_noir/index | ||
--- | ||
|
||
Proving backends each provide their own tools for working with Noir programs, providing functionality like proof generation, proof verification, and verifier smart contract generation. | ||
|
||
For the latest information on tooling provided by each proving backend, installation instructions, Noir version compatibility... you may refer to the proving backends' own documentation. | ||
|
||
You can find the full list of proving backends compatible with Noir in [Awesome Noir](https://github.com/noir-lang/awesome-noir/?tab=readme-ov-file#proving-backends). | ||
|
||
## Example: Installing `bb` | ||
|
||
`bb` is the CLI tool provided by the [Barretenberg proving backend](https://github.com/AztecProtocol/barretenberg) developed by Aztec Labs. | ||
|
||
You can find the instructions for installation in [`bb`'s documentation](https://github.com/AztecProtocol/aztec-packages/blob/master/barretenberg/cpp/src/barretenberg/bb/readme.md#installation). | ||
|
||
Once installed, we are ready to start working on [our first Noir program](../hello_noir/index.md). |
47 changes: 0 additions & 47 deletions
47
docs/versioned_docs/version-v0.31.0/getting_started/barretenberg/index.md
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.