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

chore(docs): Suggest CLI install per project #3267

Merged

ludamad merged 3 commits into master from docs/jc/cli-project-install

Nov 18, 2023

Contributor

critesjosh commented Nov 7, 2023 •

edited by ludamad

Loading

Update the docs to suggest that devs install the CLI as a dependency in their npm project instead of globally.


          suggest install per project

740f83a

critesjosh added the A-documentation label

critesjosh requested review from alexghr and rahul-kothari

November 7, 2023 15:14

critesjosh added 2 commits

November 7, 2023 10:31


          fix spelling

f6e25ab


          remove cli install section

c5f6901

ludamad approved these changes

View reviewed changes

ludamad merged commit b4c967b into master

84 checks passed

ludamad deleted the docs/jc/cli-project-install branch

November 18, 2023 08:07

AztecBot mentioned this pull request

chore(master): Release 0.15.1 #3338

Merged

rahul-kothari pushed a commit that referenced this pull request


          chore(master): Release 0.15.1 (#3338)

5cfbb68

🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.15.1</summary>

##
[0.15.1](aztec-packages-v0.15.0...aztec-packages-v0.15.1)
(2023-11-21)


### Features

* **bb:** Add ability to write pk to file or stdout
([#3335](#3335))
([c99862c](c99862c))
* DataBus PoC (UltraHonk as extension of Ultra)
([#3181](#3181))
([dd9dd84](dd9dd84))
* Deploy docs from CCI w/ netlify-cli
([#3348](#3348))
([624d733](624d733))
* Fold batching challenge (alpha)
([#3291](#3291))
([bc99a4f](bc99a4f))
* Open transcript polys as univariates in ECCVM
([#3331](#3331))
([436b22e](436b22e))
* Sandbox packages
([#3360](#3360))
([0dc2d58](0dc2d58))
* Slow updates experimentation
([#2732](#2732))
([193e6c8](193e6c8))
* ZM updates for Translator concatenated polys
([#3343](#3343))
([0e425db](0e425db))


### Bug Fixes

* Bootstrap bbjs.
([#3337](#3337))
([06aedcb](06aedcb))
* Noir-compiler breadth-first resolver
([#3307](#3307))
([02348cf](02348cf))
* Update command looks at devDeps
([#3276](#3276))
([54ee38d](54ee38d)),
closes
[#3275](#3275)
* Updating pedersen benchmarks
([#3211](#3211))
([7e89ff3](7e89ff3))
* Warn on circular imports.
([#3350](#3350))
([5bfbddb](5bfbddb))


### Miscellaneous

* All hashes in ts
([#3333](#3333))
([6307e12](6307e12))
* Compute function tree root in ts.
([#3326](#3326))
([48d8c7f](48d8c7f))
* **docs:** Suggest CLI install per project
([#3267](#3267))
([b4c967b](b4c967b))
* Enforce bracing around blocks. Generally considered easier to read and
less error prone.
([#3349](#3349))
([ee11dec](ee11dec))
* Fix circulars in foundation. Also cleanup fields and optimise to be
buffer underlying.
([#3351](#3351))
([c4bf8d3](c4bf8d3))
* Public kernel tests
([#3325](#3325))
([bace972](bace972))


### Documentation

* Fixed errors in Gas and Fees yellow paper
([#3363](#3363))
([d818206](d818206))
* Initial network section of yellow paper
([#3341](#3341))
([5a18615](5a18615))
* Yellow paper section on Gas and Fees
([#3327](#3327))
([caa7e10](caa7e10))
</details>

<details><summary>barretenberg.js: 0.15.1</summary>

##
[0.15.1](barretenberg.js-v0.15.0...barretenberg.js-v0.15.1)
(2023-11-21)


### Features

* **bb:** Add ability to write pk to file or stdout
([#3335](#3335))
([c99862c](c99862c))


### Miscellaneous

* All hashes in ts
([#3333](#3333))
([6307e12](6307e12))
</details>

<details><summary>barretenberg: 0.15.1</summary>

##
[0.15.1](barretenberg-v0.15.0...barretenberg-v0.15.1)
(2023-11-21)


### Features

* **bb:** Add ability to write pk to file or stdout
([#3335](#3335))
([c99862c](c99862c))
* DataBus PoC (UltraHonk as extension of Ultra)
([#3181](#3181))
([dd9dd84](dd9dd84))
* Fold batching challenge (alpha)
([#3291](#3291))
([bc99a4f](bc99a4f))
* Open transcript polys as univariates in ECCVM
([#3331](#3331))
([436b22e](436b22e))
* ZM updates for Translator concatenated polys
([#3343](#3343))
([0e425db](0e425db))


### Bug Fixes

* Bootstrap bbjs.
([#3337](#3337))
([06aedcb](06aedcb))
* Updating pedersen benchmarks
([#3211](#3211))
([7e89ff3](7e89ff3))


### Miscellaneous

* All hashes in ts
([#3333](#3333))
([6307e12](6307e12))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

AztecBot added a commit to AztecProtocol/barretenberg that referenced this pull request


          chore(master): Release 0.15.1 (#3338)

b26e42f

🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.15.1</summary>

##
[0.15.1](AztecProtocol/aztec-packages@aztec-packages-v0.15.0...aztec-packages-v0.15.1)
(2023-11-21)


### Features

* **bb:** Add ability to write pk to file or stdout
([#3335](AztecProtocol/aztec-packages#3335))
([c99862c](AztecProtocol/aztec-packages@c99862c))
* DataBus PoC (UltraHonk as extension of Ultra)
([#3181](AztecProtocol/aztec-packages#3181))
([dd9dd84](AztecProtocol/aztec-packages@dd9dd84))
* Deploy docs from CCI w/ netlify-cli
([#3348](AztecProtocol/aztec-packages#3348))
([624d733](AztecProtocol/aztec-packages@624d733))
* Fold batching challenge (alpha)
([#3291](AztecProtocol/aztec-packages#3291))
([bc99a4f](AztecProtocol/aztec-packages@bc99a4f))
* Open transcript polys as univariates in ECCVM
([#3331](AztecProtocol/aztec-packages#3331))
([436b22e](AztecProtocol/aztec-packages@436b22e))
* Sandbox packages
([#3360](AztecProtocol/aztec-packages#3360))
([0dc2d58](AztecProtocol/aztec-packages@0dc2d58))
* Slow updates experimentation
([#2732](AztecProtocol/aztec-packages#2732))
([193e6c8](AztecProtocol/aztec-packages@193e6c8))
* ZM updates for Translator concatenated polys
([#3343](AztecProtocol/aztec-packages#3343))
([0e425db](AztecProtocol/aztec-packages@0e425db))


### Bug Fixes

* Bootstrap bbjs.
([#3337](AztecProtocol/aztec-packages#3337))
([06aedcb](AztecProtocol/aztec-packages@06aedcb))
* Noir-compiler breadth-first resolver
([#3307](AztecProtocol/aztec-packages#3307))
([02348cf](AztecProtocol/aztec-packages@02348cf))
* Update command looks at devDeps
([#3276](AztecProtocol/aztec-packages#3276))
([54ee38d](AztecProtocol/aztec-packages@54ee38d)),
closes
[#3275](AztecProtocol/aztec-packages#3275)
* Updating pedersen benchmarks
([#3211](AztecProtocol/aztec-packages#3211))
([7e89ff3](AztecProtocol/aztec-packages@7e89ff3))
* Warn on circular imports.
([#3350](AztecProtocol/aztec-packages#3350))
([5bfbddb](AztecProtocol/aztec-packages@5bfbddb))


### Miscellaneous

* All hashes in ts
([#3333](AztecProtocol/aztec-packages#3333))
([6307e12](AztecProtocol/aztec-packages@6307e12))
* Compute function tree root in ts.
([#3326](AztecProtocol/aztec-packages#3326))
([48d8c7f](AztecProtocol/aztec-packages@48d8c7f))
* **docs:** Suggest CLI install per project
([#3267](AztecProtocol/aztec-packages#3267))
([b4c967b](AztecProtocol/aztec-packages@b4c967b))
* Enforce bracing around blocks. Generally considered easier to read and
less error prone.
([#3349](AztecProtocol/aztec-packages#3349))
([ee11dec](AztecProtocol/aztec-packages@ee11dec))
* Fix circulars in foundation. Also cleanup fields and optimise to be
buffer underlying.
([#3351](AztecProtocol/aztec-packages#3351))
([c4bf8d3](AztecProtocol/aztec-packages@c4bf8d3))
* Public kernel tests
([#3325](AztecProtocol/aztec-packages#3325))
([bace972](AztecProtocol/aztec-packages@bace972))


### Documentation

* Fixed errors in Gas and Fees yellow paper
([#3363](AztecProtocol/aztec-packages#3363))
([d818206](AztecProtocol/aztec-packages@d818206))
* Initial network section of yellow paper
([#3341](AztecProtocol/aztec-packages#3341))
([5a18615](AztecProtocol/aztec-packages@5a18615))
* Yellow paper section on Gas and Fees
([#3327](AztecProtocol/aztec-packages#3327))
([caa7e10](AztecProtocol/aztec-packages@caa7e10))
</details>

<details><summary>barretenberg.js: 0.15.1</summary>

##
[0.15.1](AztecProtocol/aztec-packages@barretenberg.js-v0.15.0...barretenberg.js-v0.15.1)
(2023-11-21)


### Features

* **bb:** Add ability to write pk to file or stdout
([#3335](AztecProtocol/aztec-packages#3335))
([c99862c](AztecProtocol/aztec-packages@c99862c))


### Miscellaneous

* All hashes in ts
([#3333](AztecProtocol/aztec-packages#3333))
([6307e12](AztecProtocol/aztec-packages@6307e12))
</details>

<details><summary>barretenberg: 0.15.1</summary>

##
[0.15.1](AztecProtocol/aztec-packages@barretenberg-v0.15.0...barretenberg-v0.15.1)
(2023-11-21)


### Features

* **bb:** Add ability to write pk to file or stdout
([#3335](AztecProtocol/aztec-packages#3335))
([c99862c](AztecProtocol/aztec-packages@c99862c))
* DataBus PoC (UltraHonk as extension of Ultra)
([#3181](AztecProtocol/aztec-packages#3181))
([dd9dd84](AztecProtocol/aztec-packages@dd9dd84))
* Fold batching challenge (alpha)
([#3291](AztecProtocol/aztec-packages#3291))
([bc99a4f](AztecProtocol/aztec-packages@bc99a4f))
* Open transcript polys as univariates in ECCVM
([#3331](AztecProtocol/aztec-packages#3331))
([436b22e](AztecProtocol/aztec-packages@436b22e))
* ZM updates for Translator concatenated polys
([#3343](AztecProtocol/aztec-packages#3343))
([0e425db](AztecProtocol/aztec-packages@0e425db))


### Bug Fixes

* Bootstrap bbjs.
([#3337](AztecProtocol/aztec-packages#3337))
([06aedcb](AztecProtocol/aztec-packages@06aedcb))
* Updating pedersen benchmarks
([#3211](AztecProtocol/aztec-packages#3211))
([7e89ff3](AztecProtocol/aztec-packages@7e89ff3))


### Miscellaneous

* All hashes in ts
([#3333](AztecProtocol/aztec-packages#3333))
([6307e12](AztecProtocol/aztec-packages@6307e12))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-documentation