oasisprotocol / oasisprotocol/docs

Enhance Localnet page

Open
#1,074 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
15
Forks
46
Avg merge
1d 21h
Merged PRs (30d)
1

Description

As a new dev the pull instructions in the setup section would be helpful

docker pull ghcr.io/oasisprotocol/sapphire-localnet:latest

As a dev on apple sillicon it would be helpful to know how to pull the image with the platform param

docker pull ghcr.io/oasisprotocol/sapphire-localnet:latest --platform linux/x86_64

this is already in the info box at the bottom and could be combined.
It could be helpful for devs on apple silicon to have this info box directly after the normal command for better visibility

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the Localnet page's setup section and locate the existing Docker pull instructions and the info box near the bottom. Move or combine the Apple Silicon platform guidance with the normal pull command, ensuring both commands remain clear and the information is not duplicated.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.