edits to change SnarkyJS latest install suggestion and other CLI prompt fixes #437
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
barriebyron
added
docs
barriebyron
commented
Jun 21, 2023
| @@ -48,9 +48,9 @@ async function deploy({ alias, yes }) { | |||
| config.deployAliases = config?.networks; | |||
|
|
|||
| if (hasBreakingChanges(installedCliVersion, latestCliVersion)) { | |||
| log(red(`You are using an old zkapp-cli version ${installedCliVersion}.`)); | |||
| log(red(`You are using an earlier zkapp-cli version ${installedCliVersion}.`)); | |||
There was a problem hiding this comment.
general advice in language is to use earlier instead of older
https://github.com/o1-labs/docs2/wiki/Word-list#earlier
and
(not sure we need to provide a version number since we detect the earlier version)
barriebyron
commented
Jun 21, 2023
| @@ -70,7 +70,7 @@ async function deploy({ alias, yes }) { | |||
| // Makes the step text green upon success, else uses reset. | |||
| const style = | |||
| state.submitted && !state.cancelled ? state.styles.success : reset; | |||
| return style('Which deploy alias would you like to deploy to?'); | |||
| return style('Which deploy alias do you want to deploy to?'); | |||
There was a problem hiding this comment.
"like" and "desire" are emotive, let's use imperative language for the prompts
barriebyron
commented
Jun 21, 2023
| @@ -137,7 +137,7 @@ async function deploy({ alias, yes }) { | |||
| return { smartContracts }; | |||
| }); | |||
|
|
|||
| // Identify which smart contract should be deployed for this deploy alias. | |||
| // Identify which smart contract to be deployed for this deploy alias. | |||
There was a problem hiding this comment.
we all want to use "should" but in technical situations, we want to avoid
see https://developers.google.com/style/word-list#letter-s
barriebyron
commented
Jun 21, 2023
| @@ -216,7 +216,7 @@ function kebabCase(str) { | |||
|
|
|||
| /** | |||
| * Fetch an example & place in the `src` directory. | |||
| * @param {string} example Name of the example, as found in our Github repo. | |||
| * @param {string} example Name of the example, as found in our GitHub repo. | |||
There was a problem hiding this comment.
yep! we misspell GitHub in many places in our docs and code (oof)
ymekuria
approved these changes
Jun 21, 2023
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 includes:
npm install snarkyjs@latest