Docs: remove references to NPM install flow #3540
Comments
This was referenced Dec 4, 2023
critesjosh
added a commit
that referenced
this issue
Dec 6, 2023
This PR removes references to installing @aztec/aztec-sandbox and @aztec/cli via NPM in favor of installing via Docker. It also updates notes about types imports for the token contract contract tutorial and the token reference in the "writing a dapp" tutorial. Note: recent additions broke the [Quickstart guide](https://docs.aztec.network/dev_docs/getting_started/quickstart). The docs got out of sync with the latest version because docs are always tested against master. This should be fixed with the new release going out tomorrow morning, so I'm not bothering to change it now, but we should test the Quickstart page again once the new release goes out. @catmcgee do you think we should implement docs versioning to help prevent this from happening? It will increase the maintenance overhead of the docs. closes #3540 #3541 # 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](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this pull request to relevant issues (if any exist). --------- Co-authored-by: Cat McGee <helloworld@mcgee.cat>
This was referenced Dec 12, 2023
critesjosh
added a commit
that referenced
this issue
Dec 13, 2023
This PR removes references to installing @aztec/aztec-sandbox and @aztec/cli via NPM in favor of installing via Docker. It also updates notes about types imports for the token contract contract tutorial and the token reference in the "writing a dapp" tutorial. Note: recent additions broke the [Quickstart guide](https://docs.aztec.network/dev_docs/getting_started/quickstart). The docs got out of sync with the latest version because docs are always tested against master. This should be fixed with the new release going out tomorrow morning, so I'm not bothering to change it now, but we should test the Quickstart page again once the new release goes out. closes #3540 #3541 # 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](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this pull request to relevant issues (if any exist). --------- Co-authored-by: Alex Gherghisan <alexghr@users.noreply.github.com>
michaelelliot
pushed a commit
to Swoir/noir_rs
that referenced
this issue
Feb 28, 2024
This PR removes references to installing @aztec/aztec-sandbox and @aztec/cli via NPM in favor of installing via Docker. It also updates notes about types imports for the token contract contract tutorial and the token reference in the "writing a dapp" tutorial. Note: recent additions broke the [Quickstart guide](https://docs.aztec.network/dev_docs/getting_started/quickstart). The docs got out of sync with the latest version because docs are always tested against master. This should be fixed with the new release going out tomorrow morning, so I'm not bothering to change it now, but we should test the Quickstart page again once the new release goes out. closes AztecProtocol#3540 AztecProtocol#3541 # 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](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this pull request to relevant issues (if any exist). --------- Co-authored-by: Alex Gherghisan <alexghr@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Npm packages are currently broken and not easy to fix, so we are favoring the docker install flow for now.
The text was updated successfully, but these errors were encountered: