1
0
Fork 0

fix(docs): (getting-started tutorials) Corrections and updates

This commit is contained in:
Benjamin F 2023-05-04 19:16:07 -07:00
parent c24461ebe0
commit 6807ad7185
6 changed files with 31 additions and 37 deletions

View file

@ -54,7 +54,7 @@ yarn new plugin
### Step by step
<Comment by="joost">
These docs assume you have git installed.
These docs assume you have git installed.
But if you're running Linux, you have git, right?
</Comment>
@ -154,12 +154,10 @@ If you're not certain what to pick, just mash some keys, it doesn't matter.
#### What package manager to use
Choose `yarn`. Currently, `npm` does not work.
You may wish to choose `yarn` since that is the package manager
that we use when doing work in the monorepo,
and many of our tutorials are written to use `yarn`.
However, it doesn't really matter.
You can choose either `yarn` or `npm` as you wish.
</Note>
<Fixme compact>
The `npm` issue issue should be fixed by the time v3 is released.
The _What package manager to use_ section will need to be updated at that
time.
</Fixme>

View file

@ -40,13 +40,13 @@ If you chose `banana`, you'll have a folder named `banana`.
You can ignore all other subfolders and files; they are part of the development environment.)
To start the development environment, enter the folder that was created
and run `npm run dev` (or `yarn dev` if you're using Yarn as a package manager).
and run `yarn dev` (or `npm run dev` if you're using npm as a package manager).
Then open your browser and go to http://localhost:8000
<Tip>
The development environment will watch for any changes you make to
the pattern's source code or configuration.
the pattern's source code or configuration.
When you do, it will update automatically in your browser.
</Tip>