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

Copy how to install and use bbup into Noir Docs #6223

Closed
Savio-Sou opened this issue Oct 3, 2024 · 2 comments
Closed

Copy how to install and use bbup into Noir Docs #6223

Savio-Sou opened this issue Oct 3, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Oct 3, 2024

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

  1. Copy instructions of how to install and use 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 Docs
  2. 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

@Savio-Sou Savio-Sou added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 3, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Oct 3, 2024
@Savio-Sou 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
@TomAFrench
Copy link
Member

I don't see how this is necessary tbh as we show examples of usage of bb in the noir docs already when relevant.

This comes at the cost of needing to manually check and update this section before each Noir release.

I guarantee that this won't end up happening and this will quickly fall out of date tbh.

@Savio-Sou
Copy link
Collaborator Author

cc @noir-lang/developerrelations would love to hear your thoughts and/or suggestions

github-merge-queue bot pushed a commit that referenced this issue Oct 19, 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>
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

3 participants