Repository navigation
Updated the "Starting a Project" docs to use the new Simple Game Dapp - #894
Conversation
Updated with new Getting Started sample dapp instructions
Fixed spacing issues
|
|
| 3. ```sh secondary style3 | ||
| # Terminal 3: web user interface | ||
| ``` | ||
| # Installing Curl |
There was a problem hiding this comment.
Let's demote installing curl to a troubleshooting box that includes the error message for when it's missing. I'm pretty sure it's not necessary for most of our audience.
Are we sure we want to use curl at all rather than just assuming folks know how to use a browser to download stuff?
There was a problem hiding this comment.
I don't see a way to install NVM via a browser. If you know of something point me in the right direction? I wanted devs to use NVM as it makes switching node versions trivial, and it seems like we have some very specific Node version dependencies which will likely shift over time.
There was a problem hiding this comment.
I don't see a way to install NVM via a browser.
The nvm install docs start with:
To install or update nvm, you should run the install script.
Folks can use their web browser to download the install script.
I wanted devs to use NVM as it makes switching node versions trivial, and it seems like we have some very specific Node version dependencies which will likely shift over time.
I'm cool with recommending nvm. I use it myself. Something like:
Install an LTS version of Node.js; for example, install nvm and use:
nvm install --lts
nvm use --lts
node --version # for example: v18.17.1That should be enough for our target audience.
There was a problem hiding this comment.
it seems like we have some very specific Node version dependencies which will likely shift over time
With occasional exceptions such as Agoric/agoric-sdk#8599 , our policy is: any LTS version of node should work.
I'm inclined to put troubleshooting stuff like 8599 in details boxes:
documentation/main/guides/getting-started/README.md
Lines 37 to 55 in 312d426
|
Why add |
|
@kbennett2000 I suggest adding to the PR description: fixes: #726 |
Co-authored-by: Dan Connolly <dckc@madmode.com>
PR #894 -- #894 Changes Made: - Fenced code blocks added - Updated `yarn start` command - Large screenshots rescaled to 800px max - Screenshots updated for all updated commands - Added caution phrasing around mnemonic phrase management - Removed selection of "Cosmos Hub" from Keplr wallet - Removed personal email address, replaced with "devrel@agoric.com" under How to Get Help section
Added line breaks between text and code blocks
| @@ -1,139 +1,292 @@ | |||
| # Starting a Project | |||
| # Your First Agoric Dapp | |||
| Getting your first Agoric application up and running! | |||
There was a problem hiding this comment.
Dapp and application... do those mean the same thing? Are you using different words on purpose?
Is this not a term we want to define on first usage?
For example:
dckc
left a comment
There was a problem hiding this comment.
this is going to help so much!
There's probably more to do, but I think all the critical stuff is here.
Updated the "Starting a Project" docs to use the new Simple Game Dapp
This fixes: transition getting started from ag-solo to smart wallet + RPC #726