45930/lightnet in readme #562
Conversation
|
@45930 thanks for PR. |
|
You can close this PR, but I'd highly recommend documenting usage of the lightnet in zkapp-cli, or linking to a more robust documentation hosted elsewhere. Why would I look in the o1js dev readme to learn how to use the zkapp-cli? |
Once mentioned documentation will be published the |
README.md
Outdated
| const feePayerAccount = feePayerPrivateKey.toPublicKey(); | ||
|
|
||
| // Fund the fee payer | ||
| Mina.faucet(feePayerAccount); |
There was a problem hiding this comment.
This is redundant in case of lightnet.
README.md
Outdated
|
|
||
| ### Block Explorer | ||
|
|
||
| If you require a block explorer, you can use [this lightweight one](https://github.com/o1-labs/mina-lightweight-explorer) alongside the lightnet. |
There was a problem hiding this comment.
In context of zkapp-cli I'd use zk lightnet explorer.
|
I don't mind at all but
Because this PR adds some description about certain sub-commands and APIs. It does not describes what the lightnet is and what other sub-commands are used for. At the same time adds yet another item for maintenance in case of future changes. |
|
@shimkiv I agree that Barrie's docs are phenomenal and the existing docs in o1js readme are better than these proposed changes. I could edit this PR to just copy the o1js docs if you want, with the goal of replacing that section entirely with a link to the full docs after MinaProtocol/docs2#780 is merged. At the moment this feature is totally undocumented in a zkapp-dev-facing location (o1js doc is for o1 devs, not o1js consumers). But we are still using it. A search in discord will reveal many recommendations to "run |
@45930 Thanks for taking the incentive to help our devs discover and use Lightnet. We appreciate you! I circled in with our product manager. The strategy is to have the docs serve as the canonical resource, so the most important thing here is the description and link to the doc. We agree, @shimkiv , that we do not want to duplicate technical information that requires maintenance. Please can you use GitHub suggestions to remove the out-of-scope lines? I've added a Lightnet description, the basic start command, the explorer command, and links to the Lightnet doc (see the preview at https://docs2-git-lightnet-minadocs.vercel.app/zkapps/testing-zkapps-lightnet#lightweight-mina-explorer live doc after PR is approved and merged). |
|
Docs were published: https://docs.minaprotocol.com/zkapps/testing-zkapps-lightnet |
There was a problem hiding this comment.
thanks for this PR @45930
Now that Lightnet docs are published, let's put the main command and the explorer and then maintain the details in the doc
There was a problem hiding this comment.
Great idea @45930 thanks Coby! I went ahead and made product-approved updates to your useful PR
| Before you test with a live network, use Lightnet to test your zkApp locally on an accurate representation of a Mina blockchain. | ||
|
|
||
| ```sh | ||
| zk lightnet |
There was a problem hiding this comment.
| zk lightnet | |
| zk lightnet --help |
Adding info in the readme about how to run the lightnet.