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.

Sign up for GitHub

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

Jump to bottom

Merge "Getting Started" documentation sections into one simple, end-to-end page #6222

Closed
2 tasks
Savio-Sou opened this issue Oct 3, 2024 · 0 comments · Fixed by #6175
Closed
2 tasks

Merge "Getting Started" documentation sections into one simple, end-to-end page #6222

Savio-Sou opened this issue Oct 3, 2024 · 0 comments · Fixed by #6175
Assignees
@signorecello
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Oct 3, 2024 •
edited
Loading

Problem

The current "Getting Started" part of the Noir docs cover multiple sections, namely:

  • Install Nargo
  • Install Proving Backend
  • Creating a Project

Image

Developers have to read through at least 3 pages just to create, prove and verify their first Noir project, which makes onboarding unnecessarily complex.

Happy Case

Tasks:

  • Merge the "Install Nargo", "Install Proving Backend" and "Creating a Project" pages → one "Getting Started" page
  • Split "Alternative Installations" and "Project Breakdown" pages out into standalone pages

The set of instructions to get started end-to-end (i.e. tooling installation and creating a project) shall be covered in 1 page, where developers should feel confident understanding the basics after reading through it.

Example: https://docs.aztec.network/guides/developer_guides/getting_started

Additional Context

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 mentioned this issue Oct 3, 2024
Closed
@signorecello signorecello mentioned this issue Oct 8, 2024
Merged
4 tasks
github-merge-queue bot pushed a commit that referenced this issue Oct 19, 2024
@signorecello @Savio-Sou @TomAFrench
chore(docs): refactoring guides and some other nits (#6175)
4302e7e 
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 Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@signorecello signorecello

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Noir
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(docs): refactoring guides and some other nits noir-lang/noir
2 participants
@signorecello @Savio-Sou