You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current "Install Proving Backend" page describes how proving backends work with Noir programs from a high level, then merely links out to Barretenberg's README as an example and leaves developers on their own to figure out how to install a proving backend.
This means developers not only have to read through instructions in the Noir Docs, but also have to hop out and read Barretenberg's documentations just to create their first Noir project.
Add a note highlighting that this is only for reference, refer to Barretenberg's documentations for the latest instructions and details
Alternative solution
We can create and establish an external-facing documentation site for Barretenberg, and link to that from the Noir Docs.
This would be nicer to search, read, consume, etc. than the current README, but it wouldn't resolve the friction of needing to hop out and back into the Noir Docs during onboarding.
Workaround
None
Workaround Description
No response
Additional Context
This comes at the cost of needing to manually check and update this section before each Noir release.
This Issue is broken out from #6175 and related discussions.
Project Impact
Nice-to-have
The text was updated successfully, but these errors were encountered:
Savio-Sou
changed the title
Copy documentations on how to install and use bbup into Noir Docs as a proving backend specific example
Copy how to install and use bbup into Noir Docs
Oct 3, 2024
This closes the remaining work for restoring some of the devex
regression around noir and bb, and other docs improvements including
homepage removal and redirects set-up.
- [x] Made "Getting Started" E2E with `bbup` and `bb` as examples
(closes#6222 and #6223)
- [x] Removed BB specific documentation
- [x] Updated docusaurus to latest
- [x] Made homepage CTA open the docs in the same tab
---------
Co-authored-by: Savio <72797635+Savio-Sou@users.noreply.github.com>
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
Problem
The current "Install Proving Backend" page describes how proving backends work with Noir programs from a high level, then merely links out to Barretenberg's README as an example and leaves developers on their own to figure out how to install a proving backend.
This means developers not only have to read through instructions in the Noir Docs, but also have to hop out and read Barretenberg's documentations just to create their first Noir project.
Happy Case
bbup
in Barretenberg's README into the "Install Proving Backend" page (or the "Getting Started" page if Merge "Getting Started" documentation sections into one simple, end-to-end page #6222 is completed) of the Noir DocsAlternative solution
We can create and establish an external-facing documentation site for Barretenberg, and link to that from the Noir Docs.
This would be nicer to search, read, consume, etc. than the current README, but it wouldn't resolve the friction of needing to hop out and back into the Noir Docs during onboarding.
Workaround
None
Workaround Description
No response
Additional Context
This comes at the cost of needing to manually check and update this section before each Noir release.
This Issue is broken out from #6175 and related discussions.
Project Impact
Nice-to-have
The text was updated successfully, but these errors were encountered: