-
Notifications
You must be signed in to change notification settings - Fork 11.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[wallet + docs] Added history command and more interactive shell doc #765
Conversation
|
||
In order to build a Move package and run code defined in this package, | ||
clone the Sui repository to the current directory and build: | ||
### Installing the binaries |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section is referenced from move.md in the following sentence:
"In order to be able to build a Move package and run code defined in this package, first clone the Sui repository to the current directory and build Sui binaries."
It would be good to update this reference as part of this PR, possibly rewriting it a bit to avoid redundancy, for example:
"In order to be able to build a Move package and run code defined in this package first install Sui binaries as described here."
Looking a bit further in the text, I realize that sui-move
command is not installed here, but I think that it probably should, rather than describing cloning, cargo etc. in move.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah didn't know this is referenced from elsewhere...
Will it make more sense to split out installing cargo and sui binaries to its own file? Usually installation/building instruction should locate in the Get Started section.
cc @Clay-Mysten
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah didn't know this is referenced from elsewhere...
That's totally understandable :-)
Will it make more sense to split out installing cargo and sui binaries to its own file? Usually installation/building instruction should locate in the Get Started section.
cc @Clay-Mysten
This is a good question and @Clay-Mysten is the best person to answer I think. On one hand including full instructions in move.md is less error prone, but on the other hand it's a bit redundant. Considering a low level of redundancy, though, perhaps it's not so bad after all.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this should fall in a central Install section that is still missing from our doc set. Sam has asked for IDE setup there, as well. I would like minimal hardware and software requirements.
@sblackshear asked @lxfind to take a run at this in the Dev Portal Sitemap comments thread (the best thing we have to an overall doc tracker at the moment). Someone, please help centralize this knowledge and then link to it from all required pages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please see we have fodder here:
https://github.com/MystenLabs/sui/blob/main/CONTRIBUTING.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will remove the --bin flag in the instruction so all the binaries will be installed.
We can decide where to move this section when the central install section is more complete
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would settle upon whether you want to precede commands with dollar signs ($) as my tests from GitHub showed they got picked up in the copy when using the built-in copy command function. Try it yourself in previous mode.
The dollar signs was "inspired" by rust doc :) I do notice the copy button will copy the dollar sign as well... however I think we need to somehow distinguish the input form the output, are there better way to do this? |
Sadly, I don't see a quick fix and the issue is pervasive: In my old content management system, the dollar signs were included in view but stripped upon copy: @Jibz1 for ideas in our system. |
Ah that make sense now..... we only need dollar sign when the input and output are mixed in one code block, as (meilisearch/integration-guides#103) illustrated. |
33e317d
to
8b2c673
Compare
@Clay-Mysten @awelc , I have addressed most of the comments, can I have a thumbs up if this looks ok to you? |
* added docs for interactive shell functionalities - history, tab completion and env variable substitution * changed binaries installation instruction in doc, using cargo install instead of build.
Make edits to latest additions (history, namely)
d196c86
to
b4fe33b
Compare
@awelc are you ok with the changes? |
Sorry, did not know that you waited for my stamp as well... |
TODOs/ future enhancement :