Skip to content
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

Update CLI Docs #57

Merged
merged 11 commits into from
May 25, 2024
Merged

Update CLI Docs #57

merged 11 commits into from
May 25, 2024

Conversation

sambukowski
Copy link
Contributor

Description

Update the cli tutorial sections for the go cli.
Bring those same sections up to date for use with Dusk-5

Copy link
Contributor

@quasystaty1 quasystaty1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Section on common issues is great addition!
LGTM

docs/developer/tutorials/install-the-cli.md Show resolved Hide resolved
docs/developer/tutorials/install-the-cli.md Show resolved Hide resolved
sambukowski and others added 3 commits May 1, 2024 13:59
Co-authored-by: quasystaty <121364949+quasystaty1@users.noreply.github.com>
@jbowen93
Copy link
Member

jbowen93 commented May 1, 2024

We should update the installing go-ethereum component to use github.com/astriaorg/astria-geth instead of github.com/astriaorg/go-ethereum

@jbowen93
Copy link
Member

jbowen93 commented May 1, 2024

for local rollup and local sequencer instructions there is no step to specify a custom config for geth

 "config": {
        "chainId": <6 digit number>,
				...
        "astriaRollupName": "<rollup name>"
    },

this means that when we get to the test transactions phase the user doesn't know the chain-id of their geth node

@sambukowski
Copy link
Contributor Author

We should update the installing go-ethereum component to use github.com/astriaorg/astria-geth instead of github.com/astriaorg/go-ethereum

It is update to this for all the go-cli stuff, but not for the rest of the existing docs.

@sambukowski
Copy link
Contributor Author

for local rollup and local sequencer instructions there is no step to specify a custom config for geth

If they are just running things locally and pulling the repos for local everything, they don't need to update these. The default chain id and rollup name when pulling geth and the test transactions are the same.

I'll add that section though, to avoid confusion.

@sambukowski sambukowski changed the title Update CLI Tutorial Docs Update CLI Docs May 22, 2024
@jbowen93 jbowen93 merged commit fa51e43 into main May 25, 2024
2 checks passed
@jbowen93 jbowen93 deleted the update-cli-tutorial-docs branch May 25, 2024 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants