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/feat: zk lightnet #780

Merged
merged 25 commits into from
Jan 25, 2024
Merged

docs/feat: zk lightnet #780

merged 25 commits into from
Jan 25, 2024

Conversation

barriebyron
Copy link
Contributor

@barriebyron barriebyron commented Dec 13, 2023

This PR closes #726 and begins the work to document the workflow for testing with the lightnet

Files for review

Sidebar updates

  • rename Overview in the sidebar to zkApps Overview
  • move How zkApps Work under zkApps Overview

Other updates, with more to follow in the next PR:

Copy link

vercel bot commented Dec 13, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 25, 2024 7:58pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
07-oracles ⬜️ Ignored (Inspect) Visit Preview Jan 25, 2024 7:58pm

@barriebyron barriebyron added docs Improvements or additions to documentation enhancement New feature or request zkApps Focused zkApps content labels Dec 13, 2023
@nicc
Copy link
Contributor

nicc commented Dec 14, 2023

Early bit of feedback: I think 'a lightnet' sounds awkward. Even 'the lightnet' feels a little off to me. I think the issue is that we refer to it as if it's an establisehd thing but it's just our name. Would suggest referring to 'a/the local network' instead. If we need to use 'lightnet' then I think we should use it like a proper noun and still avoid 'a' or 'the'. Totally get that it's a draft so I hope this isn't premature!

docs/zkapps/lightnet.mdx Outdated Show resolved Hide resolved
@barriebyron barriebyron self-assigned this Jan 24, 2024
@barriebyron barriebyron marked this pull request as ready for review January 24, 2024 16:04
@barriebyron barriebyron requested a review from a team as a code owner January 24, 2024 16:04
docs/zkapps/lightnet.mdx Outdated Show resolved Hide resolved
docs/zkapps/lightnet.mdx Outdated Show resolved Hide resolved
docs/zkapps/lightnet.mdx Outdated Show resolved Hide resolved
zk lightnet status
```

The network status is returned, including useful URLs. For example, the default single node network status returns these useful URLs:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The network status is returned, including useful URLs. For example, the default single node network status returns these useful URLs:
The network status is returned, including useful URLs. For example, the default single node network status returns these endpoints:

??

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Your question marks mean you have a question? Can you elaborate please? @nicc

docs/zkapps/lightnet.mdx Outdated Show resolved Hide resolved
getting-started-zkapps.mdx Outdated Show resolved Hide resolved
Co-authored-by: garwalsh <gwalsh@gmail.com>
Co-authored-by: Nic Young <20563+nicc@users.noreply.github.com>
@barriebyron barriebyron merged commit eda1fbd into main Jan 25, 2024
4 checks passed
@barriebyron barriebyron deleted the lightnet branch January 25, 2024 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement New feature or request zkApps Focused zkApps content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the "zk lightnet" subcommand at docs.minaprotocol.com
4 participants