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

docs: quick start guide improvements #1756

Open
jcstein opened this issue Oct 17, 2024 · 0 comments
Open

docs: quick start guide improvements #1756

jcstein opened this issue Oct 17, 2024 · 0 comments
Assignees
Labels
P0 Top priority

Comments

@jcstein
Copy link
Member

jcstein commented Oct 17, 2024

Suggestion from @msuiche on getting started page:

# Getting Started
## Run Light Node
build/celestia light init
build/celestia light start 
## Get Auth Key
build/celestia light auth admin --p2p.network mainnet
### Write a section about cel-key to explain the difference
### Write a section about the difference between --core.ip and --p2p.network (or change the names into something more explicit)
## Test Client using above
### Rust Client w/ Lumina
### Go Client w/ Normal stuff
## Troubleshooting
### Section about .celestia* folders and the differences
  • clear the flags up so they're abundantly clear
    --fullnode.ip --network
  • rust could be improved, needs to be updated
  • "node tutorial" - title should be more clear

https://docs.celestia.org/how-to-guides/quick-start - I think the updated guide would be good here

A lot of this already exists, just needs to be reorganized and pulled into the quickstart page to improve it

@jcstein jcstein self-assigned this Oct 17, 2024
@jcstein jcstein added the P0 Top priority label Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P0 Top priority
Projects
None yet
Development

No branches or pull requests

1 participant