-
Notifications
You must be signed in to change notification settings - Fork 324
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
add orbit start command #615
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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.
Few edits and then it's all good!
arbitrum-docs/launch-orbit-chain/how-tos/customize-precompile.mdx
Outdated
Show resolved
Hide resolved
arbitrum-docs/launch-orbit-chain/how-tos/customize-precompile.mdx
Outdated
Show resolved
Hide resolved
@@ -43,7 +43,11 @@ function sayHi() external view returns(string memory); | |||
|
|||
Next, build Nitro by following steps 3-7 of the instructions in [How to build Nitro locally](/node-running/how-tos/build-nitro-locally). Note that if you've already built the Docker image, you still need run the last step to rebuild. | |||
|
|||
Run Nitro by following the instructions in [How to run a full node](/node-running/how-tos/running-a-full-node#putting-it-all-together). | |||
Run Nitro by following the instructions (Note the instructions in [How to run a full node](/node-running/how-tos/running-a-full-node#putting-it-all-together) cann't start orbit node): |
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.
Run Nitro by following the instructions (Note the instructions in [How to run a full node](/node-running/how-tos/running-a-full-node#putting-it-all-together) cann't start orbit node): | |
Run Nitro with the following command: |
Proposed change. It feels weird to link to a page when we're saying that you can't use the information in that page. Maybe we could add a link below the command with something like "for additional, optional parameters see How to run a full node".
What do you think?
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.
@mahsamoosavi suggested something interesting that I hadn't thought about: users might think that the other instructions are valid if we don't explicit that.
So we can leave the message on top as the original edit, or place it below if it makes more sense, but keeping the note saying that they don't work for Orbit chains.
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.
@TucksonDev @mahsamoosavi this PR introduces an admonition to set expectations while linking to CLI options 🤙
Co-authored-by: Mahsa Moosavi <mahsa.msv1991@gmail.com>
Co-authored-by: Mahsa Moosavi <mahsa.msv1991@gmail.com>
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.
LGTM!
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.
Thanks so much @Jason-Wanxt & co 🔥
|
||
:::info | ||
|
||
Note that the instructions provided in [How to run a full node](/node-running/how-tos/running-a-full-node) **will not** work with your Orbit node, but the flags in [Command-line options](/node-running/command-line-options) **will**. |
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.
Ohhh, it looks great!
One thing to note is that some of the command line options will not work with the Orbit node. We could replace them with these optional parameters for example. They will work and they might be useful for users 💪
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.
Ty @TucksonDev - #620 is an attempt to address this
`add-orbit-command-edit-2`
Hey there!
Thanks!💙🧡 |
No description provided.