docs: update docs #3223

alexghr · 2023-11-03T15:37:45Z

This PR aims to update the docs with latest changes in the CLI (noir_wasm & update command)

Relates to #3195

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
Every change is related to the PR description.
I have linked this pull request to relevant issues (if any exist).

critesjosh · 2023-11-06T13:52:18Z

docs/docs/dev_docs/cli/updating.md


 ```shell
-  /bin/bash -c "$(curl -fsSL 'https://sandbox.aztec.network')"
+cd your/aztec/project
+npx @aztec/cli@latest update . --contract src/contract1 --contract src/contract2


@alexghr the sandbox has to running for this command to work, correct?

There's two possibilities:

if the project has @aztec/aztec-sandbox listed as a dependency in package.json then it will compare against that version

otherwise it grabs the version of the running sandbox. If sandbox isn't running it exits and prints the error message:

Could not connect to Sandbox running on <url>

critesjosh · 2023-11-06T15:29:45Z

Let's wait until the release to merge this

rahul-kothari

Getting started/quickstart still talks about downlaoding the cli when it is not needed

I am going to add another point in the issue of using the word "noir project" as opposed to "nargo project"

docs/docs/dev_docs/cli/cli-commands.md

docs/docs/dev_docs/updating.md

rahul-kothari · 2023-11-06T17:59:16Z

docs/docs/dev_docs/updating.md

-aztec = { git="https://github.com/AztecProtocol/aztec-packages", tag="#include_aztec_version", directory="yarn-project/aztec-nr/aztec" }
-value_note = { git="https://github.com/AztecProtocol/aztec-packages", tag="#include_aztec_version", directory="yarn-project/aztec-nr/value-note" }
-```
+This will update `@aztec/*` dependencies in `package.json` as well as Aztec.nr libraries in `Nargo.toml` to the latest version. If `@aztec/sandbox` and `@aztec/cli` are listed as dependencies then they will be automatically updated as well.

 Read on to learn about versioning and other commands.



Expand on how to update in the docker flow.
WHy do we need the remainder of the file?

I added some detail and trimmed some of the remainder of the file. I left part of it because I think it provides helpful context.

docs/docs/dev_docs/contracts/compiling.md

docs/docs/dev_docs/getting_started/aztecnr-getting-started.md

Co-authored-by: Rahul Kothari <rahul.kothari.201@gmail.com>

…ocol/aztec-packages into alexg/docs/update-docs

🤖 I have created a release *beep* *boop* --- <details><summary>aztec-packages: 0.14.0</summary> ## [0.14.0](aztec-packages-v0.13.1...aztec-packages-v0.14.0) (2023-11-07) ### ⚠ BREAKING CHANGES * make noir_wasm the default compiler ([#3090](#3090)) * adding all the (note, nonce) pairs in `PXE.addNote` and hiding `PXE.getNoteNonces` ([#3196](#3196)) * API inconsistency fix ([#3190](#3190)) * tree leaf value as `Fr` everywhere in our public API ([#3173](#3173)) ### Features * Add cli command update aztec dependencies ([#3128](#3128)) ([0c05d8b](0c05d8b)) * Add root rollup circuit ([#3217](#3217)) ([fb4f7af](fb4f7af)) * Adding all the (note, nonce) pairs in `PXE.addNote` and hiding `PXE.getNoteNonces` ([#3196](#3196)) ([8c41664](8c41664)) * API inconsistency fix ([#3190](#3190)) ([272eda1](272eda1)) * **docs:** Aztec.nr errors in docs ([#3113](#3113)) ([fb1e80b](fb1e80b)) * **docs:** New getting started flow ([#2957](#2957)) ([f23f868](f23f868)) * Enable pkc in noir ([#3194](#3194)) ([1ef892b](1ef892b)) * Extract types to a types crate ([#3203](#3203)) ([4161be9](4161be9)) * Gperftools ([#3096](#3096)) ([ea2f9a7](ea2f9a7)) * Initial storage slots docs ([#2842](#2842)) ([e8bcd03](e8bcd03)) * Make noir_wasm the default compiler ([#3090](#3090)) ([ca52a3e](ca52a3e)) * Migrate cpp private kernel tests to noir ([#3165](#3165)) ([daee2f9](daee2f9)) * More test info in tx receipt ([#3221](#3221)) ([a7354dc](a7354dc)), closes [#3218](#3218) * Tag artifacts with the compiler version ([#3220](#3220)) ([c7490c5](c7490c5)) * Tree leaf value as `Fr` everywhere in our public API ([#3173](#3173)) ([09464ca](09464ca)) ### Bug Fixes * Attempt to fix spot request hangs. ([#3241](#3241)) ([a062026](a062026)) * Better update steps for dockerized sandbox ([#3204](#3204)) ([3ef0bee](3ef0bee)) * Build cli image before releasing ([#3140](#3140)) ([09c3b75](09c3b75)) * Cleanup gen_inner_proof_files.sh script. ([#3242](#3242)) ([ee57e00](ee57e00)) * Corrects typo in repo readme ([#3236](#3236)) ([0ed8c79](0ed8c79)) * Remove noirup from noir-contract's bootstrap ([#3252](#3252)) ([d10342e](d10342e)) * Remove unused import ([#3200](#3200)) ([520bba4](520bba4)) * Temporary fix for bb prove w/ ram rom blocks ([#3215](#3215)) ([af93a33](af93a33)) * Update noir-contracts path to types ([#3247](#3247)) ([c5fc95d](c5fc95d)) * Wasm-compiler `bin` package type ([#3254](#3254)) ([2d50f11](2d50f11)) * Yarn prepare ([#3251](#3251)) ([d02726f](d02726f)) ### Miscellaneous * Add initial skeleton code for root/merge/mase rollups for Noir ([#3178](#3178)) ([7b0d076](7b0d076)) * Bump noir ([#3197](#3197)) ([aa2042d](aa2042d)) * Clean up and refactor arithmetization ([#3164](#3164)) ([0370b13](0370b13)) * Continuation of note naming update ([#3137](#3137)) ([582150f](582150f)) * Disable canary. ([#3244](#3244)) ([1a56173](1a56173)) * Docs: fix broken link in functions.md ([#3183](#3183)) ([fb53f7a](fb53f7a)) * **docs:** Fix docs build ([#3249](#3249)) ([ec2c0cf](ec2c0cf)) * Fix typo in aztec sandbox ([#3191](#3191)) ([ed144b1](ed144b1)) * More boiler plate code for merge rollup ([#3182](#3182)) ([ffafcef](ffafcef)) * Move flavors ([#3188](#3188)) ([f1ff849](f1ff849)) * Move honk/pcs ([#3187](#3187)) ([3870ff8](3870ff8)) * Move log deriv lookup accum to library ([#3226](#3226)) ([189d1bb](189d1bb)) * Move sumcheck ([#3189](#3189)) ([410cae3](410cae3)) * Move transcripts ([#3176](#3176)) ([7372d19](7372d19)) * Noir circuit tests ([#3229](#3229)) ([dbfb086](dbfb086)) * Private kernel circuits ([#3240](#3240)) ([b7fbe19](b7fbe19)) * Prune 0 values from L2Tx ([#3224](#3224)) ([2de206d](2de206d)) * Refactor e2e to not use @aztec/types ([#3175](#3175)) ([006a07a](006a07a)), closes [#3157](#3157) * Remove extra println in noir protoco circuit ([#3219](#3219)) ([3295fdd](3295fdd)) * Split out relations, PG, Honk variants ([#3238](#3238)) ([8abd39f](8abd39f)) * Update Noir version ([#3082](#3082)) ([59eb6af](59eb6af)) ### Documentation * Fix bad shareable key crypto. better explanations ([#3228](#3228)) ([e4a0c4a](e4a0c4a)) * Fix in nullifier secrets doc ([#3167](#3167)) ([8c70845](8c70845)) * Move Updating.md file, add aztec tag to nargo update instruction ([#3213](#3213)) ([9f71c5d](9f71c5d)) * Update docs ([#3223](#3223)) ([7977064](7977064)) * Update storage doc ([#3212](#3212)) ([d707d4e](d707d4e)) * Updated stale tree docs ([#3166](#3166)) ([3d5c98c](3d5c98c)) </details> <details><summary>barretenberg.js: 0.14.0</summary> ## [0.14.0](barretenberg.js-v0.13.1...barretenberg.js-v0.14.0) (2023-11-07) ### Miscellaneous * **barretenberg.js:** Synchronize aztec-packages versions </details> <details><summary>barretenberg: 0.14.0</summary> ## [0.14.0](barretenberg-v0.13.1...barretenberg-v0.14.0) (2023-11-07) ### Features * Gperftools ([#3096](#3096)) ([ea2f9a7](ea2f9a7)) ### Bug Fixes * Cleanup gen_inner_proof_files.sh script. ([#3242](#3242)) ([ee57e00](ee57e00)) * Temporary fix for bb prove w/ ram rom blocks ([#3215](#3215)) ([af93a33](af93a33)) ### Miscellaneous * Clean up and refactor arithmetization ([#3164](#3164)) ([0370b13](0370b13)) * Move flavors ([#3188](#3188)) ([f1ff849](f1ff849)) * Move honk/pcs ([#3187](#3187)) ([3870ff8](3870ff8)) * Move log deriv lookup accum to library ([#3226](#3226)) ([189d1bb](189d1bb)) * Move sumcheck ([#3189](#3189)) ([410cae3](410cae3)) * Move transcripts ([#3176](#3176)) ([7372d19](7372d19)) * Split out relations, PG, Honk variants ([#3238](#3238)) ([8abd39f](8abd39f)) ### Documentation * Updated stale tree docs ([#3166](#3166)) ([3d5c98c](3d5c98c)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

alexghr added 2 commits November 3, 2023 15:37

docs: update docs

2e8bdca

docs: document aztec-cli update command

771de58

critesjosh reviewed Nov 6, 2023

View reviewed changes

add new setup info

6f8f879

critesjosh marked this pull request as ready for review November 6, 2023 15:19

critesjosh requested review from rahul-kothari and catmcgee November 6, 2023 15:19

critesjosh and others added 4 commits November 6, 2023 10:20

clarify

c51278f

add clarifying notes

d5784a5

Merge branch 'master' into alexg/docs/update-docs

aa6ce38

Merge branch 'master' into alexg/docs/update-docs

10f8309

critesjosh added 3 commits November 6, 2023 10:38

fix link

eec9646

fix link

da8bbeb

add note on sandbox as dep

af89571

rahul-kothari reviewed Nov 6, 2023

View reviewed changes

critesjosh and others added 10 commits November 6, 2023 14:59

Update docs/docs/dev_docs/cli/cli-commands.md

aca597f

Co-authored-by: Rahul Kothari <rahul.kothari.201@gmail.com>

Update docs/docs/dev_docs/cli/cli-commands.md

f51f841

Co-authored-by: Rahul Kothari <rahul.kothari.201@gmail.com>

Update docs/docs/dev_docs/updating.md

ea99533

Co-authored-by: Rahul Kothari <rahul.kothari.201@gmail.com>

add rahuls feedback

06d3e80

Merge

73e0251

Update docs/docs/dev_docs/contracts/compiling.md

547d586

Co-authored-by: Rahul Kothari <rahul.kothari.201@gmail.com>

Merge branch 'alexg/docs/update-docs' of https://github.com/AztecProt…

9ad59d7

…ocol/aztec-packages into alexg/docs/update-docs

remove unnecessary references

0231407

remove extra details

87d4e65

add note on aztec-cli update

c69ad90

critesjosh requested a review from rahul-kothari November 6, 2023 20:20

critesjosh and others added 3 commits November 6, 2023 15:29

update refs to Noir project, npm in quickstart

5a17f5e

make some improvemnts + refactor update page

5583df8

Merge branch 'master' into alexg/docs/update-docs

2d9f58d

rahul-kothari approved these changes Nov 7, 2023

View reviewed changes

rahul-kothari merged commit 7977064 into master Nov 7, 2023
2 checks passed

rahul-kothari deleted the alexg/docs/update-docs branch November 7, 2023 10:37

AztecBot mentioned this pull request Nov 7, 2023

chore(master): Release 0.14.0 #3158

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update docs #3223

docs: update docs #3223

alexghr commented Nov 3, 2023 •

edited

Loading

critesjosh Nov 6, 2023

alexghr Nov 6, 2023

critesjosh commented Nov 6, 2023

rahul-kothari left a comment

rahul-kothari Nov 6, 2023

critesjosh Nov 6, 2023

docs: update docs #3223

docs: update docs #3223

Conversation

alexghr commented Nov 3, 2023 • edited Loading

Checklist:

critesjosh Nov 6, 2023

Choose a reason for hiding this comment

alexghr Nov 6, 2023

Choose a reason for hiding this comment

critesjosh commented Nov 6, 2023

rahul-kothari left a comment

Choose a reason for hiding this comment

rahul-kothari Nov 6, 2023

Choose a reason for hiding this comment

critesjosh Nov 6, 2023

Choose a reason for hiding this comment

alexghr commented Nov 3, 2023 •

edited

Loading