chore(docs): Remove references to npm from docs #3587
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Cat McGee <[email protected]>
…tocol/aztec-packages into docs/jc/remove-npm-refs
4 tasks
critesjosh
changed the title
alexghr
approved these changes
Dec 6, 2023
|
|
||
| ```shell | ||
| npm install -g @aztec/cli | ||
| /bin/bash -c "$(curl -fsSL 'https://sandbox.aztec.network')" |
There was a problem hiding this comment.
I think this will eventually get changed to install.aztec.network but I'm not sure when.
There was a problem hiding this comment.
Cool, ill leave it for now then.
|
|
||
| ### Note on Linux | ||
|
|
||
| If you are running Linux, you will need to set the context (because Docker Desktop runs in a VM by default). See [this page](https://docs.docker.com/desktop/faqs/linuxfaqs/#what-is-the-difference-between-docker-desktop-for-linux-and-docker-engine) for more information. You can do this by running: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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. 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.