chore(docs): refactoring guides and some other nits #6175
Conversation
github-actions
bot
added
the
documentation
|
🚀 Deployed on https://66facccce5199914d3de39fa--noir-docs.netlify.app |
signorecello
force-pushed
the
zpedro/docs_noirenberg
branch
from
302766f
to
4fb7a9f
Compare
signorecello
force-pushed
the
zpedro/docs_noirenberg
branch
from
0e3ec01
to
1999968
Compare
There was a problem hiding this comment.
This PR is enshrining noirenberg as the primary installation method for Noir which isn't what was agreed on slack and is a "backtrace into the valley" as @Savio-Sou put it. It can be placed in "Alternative installations" under noirup or under bb in "Proving backend installation" but it's not an installation method which is supported and tested by the Noir team so it should not take priority over noirup.
We should also not merge the "hello noir" page into the installation tooling page as they're two separate things and if we're having multiple installation methods then it doesn't make sense to inline that content into just one of them.
|
do we want to remove the homepage? I thought we were going to to keep it (@Savio-Sou) since you don't typically first land on a docs site when going a web page. I know the homepage right now isn't the prettiest, but at least it works as a placeholder so if we want to update the homepage in the future we won't have to restructure again. Removing the homepage will also break all existing links to noir docs out on the web since it removes |
|
I was under the impression we wanted to remove it but didn't because of the redirects, but I fixed the redirects in netlify.toml (links with /docs/ redirect to the correct pages) Glad to keep it, though, if it's useful |
|
I'll defer to @Savio-Sou on whether we want to keep it or not. |
signorecello
changed the title
We would like to update it in the long run. I would prefer keeping it unless it is stirring confusions / frictions in our community. |
|
Created #6222 and #6223 (also partly relevant AztecProtocol/aztec-packages#8530) from this PR. Recommend closing and splitting this PR up to tackle the Issues individually; easier to review and merge that way. |
|
Keeping the homepage, this PR actually does only one thing, which is updating docs. It does tackle two issues because the new getting started guide does both. I'll make the change to keep the homepage |
|
Thanks Ze, let us know when the PR description + PR is ready for a re-reivew 🙌 |
signorecello
force-pushed
the
zpedro/docs_noirenberg
branch
from
26b99b1
to
e5f6027
Compare
docs/.markdownlint.json
Outdated
There was a problem hiding this comment.
Because I wanted to remove the only rule there so it didn't make sense to keep the file
docs/docs/getting_started.md
Outdated
| The easiest way to use Noir is through `nargo` (inspired by Rust's `cargo`). You can use `noirup` to quickly install `nargo`: | ||
|
|
||
| ```bash | ||
| curl -L noirup.dev | bash |
There was a problem hiding this comment.
Who currently owns this domain?
There was a problem hiding this comment.
I have it for the time being
There was a problem hiding this comment.
To minimize complications / risks, best to:
- First transfer ownership, or
- Revert to the GitHub hyperlink
before merging.
There was a problem hiding this comment.
Agreed, I'd like this to be an "officially owned" domain before we push people towards it.
There was a problem hiding this comment.
I'll transfer the ownership before merging so we don't have to iterate later
There was a problem hiding this comment.
This domain is still pointing at https://raw.githubusercontent.com/AztecProtocol/aztec-packages/refs/heads/zpedro/bbup_and_docs/barretenberg/bbup/install which now 404s
There was a problem hiding this comment.
Both noirup and bbup seems to work
|
On my recent commit b9801d0, not sure if that conflicts with any best practices, but having Quick Start as a standalone page feels more natural to me than as the Getting Started category page. (Sorry for pushing it directly, not sure how to cleanly commit locally edits as PR suggestions; feel free to revert if undesirable.) |
Co-authored-by: Savio <[email protected]>
Co-authored-by: Savio <[email protected]>
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.
bbupandbbas examples (closes Merge "Getting Started" documentation sections into one simple, end-to-end page #6222 and Copy how to install and usebbupinto Noir Docs #6223)