Skip to content

Conversation

@Abhilashaa08
Copy link

Summary

< Improve onboarding instructions by updating the README.md with clear prerequisites, quickstart steps, and troubleshooting notes for running make localnet_up.>

git --no-pager diff main  -- ':!*.pb.go' ':!*.json' ':!*.yaml' ':!*.yml' ':!*.gif' ':!*.lock' | diff2html -s side --format json -i stdin -o stdout | pbcopy

Primary Changes:

  • < Added Prerequisites section listing required tools (gnu-sed, grep, yq, kind, tilt) and the correct Go version (1.23.x).>
  • < Added Quickstart (Localnet) section with commands to spin up the network and initialize accounts. >

Secondary Changes:

  • < Added a Troubleshooting note for the common relay error when make acc_initialize_pubkeys is not run. >

Issue

  • Issue_or_PR: #{N/A}

Type of change

Select one or more from the following:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • [ >] Documentation
  • Other (specify)

Sanity Checklist

  • [ >] I have updated the GitHub Issue Metadata: assignees, reviewers, labels, project, iteration and milestone
  • [ >] For docs: make docusaurus_start
  • For small changes: make go_develop_and_test and make test_e2e
  • For major changes: devnet-test-e2e label to run E2E tests in CI
  • For migration changes: make test_e2e_oneshot
  • [ >] 'TODO's, configurations and other docs

@Olshansk Olshansk self-requested a review September 30, 2025 02:33
@Olshansk Olshansk self-assigned this Sep 30, 2025
@Olshansk Olshansk added this to Shannon Sep 30, 2025
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Shannon Sep 30, 2025
@Olshansk Olshansk moved this from 📋 Backlog to 👀 In review in Shannon Sep 30, 2025
@Olshansk Olshansk added this to the Quality of Life milestone Sep 30, 2025
@Olshansk
Copy link
Collaborator

@Abhilashaa08 This is great - ty!

Any chance you could share a video or screenshot of you running it?

Would also appreciate if you can upadate the GitHub description.

Comment on lines +40 to +44
brew install gnu-sed
brew install grep
brew install yq
brew install kind
brew install tilt
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we single line this?

Comment on lines +46 to +48
# Verify Go version (must be 1.23.x, NOT 1.24+)
go version
# Expected output: go1.23.12 darwin/arm64
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a way to update go.mod or other tooling to avoid additional cognitive overhead on the reader?


```


Copy link
Collaborator

Choose a reason for hiding this comment

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

Please fix spacing here and below

# Initialize accounts (required for relays & tests)
make acc_initialize_pubkeys POCKET_NODE=http://localhost:26657
```
Troubleshooting
Copy link
Collaborator

Choose a reason for hiding this comment

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

Missing header




# Quickstart (Localnet)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# Quickstart (Localnet)
## Quickstart (Localnet)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

2 participants