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

Add tutorial 3 to CI #567

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Add tutorial 3 to CI #567

wants to merge 18 commits into from

Conversation

Trivo25
Copy link
Member

@Trivo25 Trivo25 commented Aug 17, 2023

this adds tutorial 3 to the CI tutorial runner. It deploys the contract from tutorial 01 to a local network using the zkapp cli.
FYI some changes to the tutorials (01 and 03) are due to automatic formatting, they just deleted some trailing spaces :X

@Trivo25 Trivo25 requested a review from a team as a code owner August 17, 2023 17:05
@vercel
Copy link

vercel bot commented Aug 17, 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 Sep 7, 2023 11:57am

@Trivo25 Trivo25 changed the title [WIP - do not merge] Add tutorial 3 to CI Add tutorial 3 to CI Aug 28, 2023
Copy link
Contributor

@mitschabaude mitschabaude left a comment

Choose a reason for hiding this comment

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

nice work! I had a couple of naive questions about the tutorial runner for my understanding. Also don't understand what role mina-lightnet plays here

The expected output is:

```sh
✔ Create an accompanying UI project too? · none
Copy link
Contributor

Choose a reason for hiding this comment

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

out of curiosity - does the tutorial runner parse this to figure out what option to select? or how does it work?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, it only parses shell commands if they begin with $, rest is ignored

Copy link
Contributor

Choose a reason for hiding this comment

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

so how does it select the none option then? there's a second snippet which shows the choice but it also doesn't have a leading $

Copy link
Member Author

Choose a reason for hiding this comment

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

Or this particular snippet doesn't execute or do anything, it's just rendered to indicate to the reader what to choose

Copy link
Contributor

Choose a reason for hiding this comment

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

I still don't get how the tutorial runner ends up making a choice for the UI project option 😅

Copy link
Member Author

Choose a reason for hiding this comment

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

Ohh!! We have a flag --ui none that the runner is using :D

Copy link
Contributor

Choose a reason for hiding this comment

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

@mitschabaude and @Trivo25

The docs style guide describes the tutorial runner, can we verify the technical accuracy, please?

https://github.com/o1-labs/docs2/wiki/Tutorial-Runner

docs/zkapps/tutorials/01-hello-world.mdx Show resolved Hide resolved
Comment on lines +108 to +112
```sh
$ rm src/Add.ts
$ rm src/Add.test.ts
$ rm src/interact.ts
```
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: could be collapsed into one line

$ rm src/Add.ts src/Add.test.ts src/interact.ts

docs/zkapps/tutorials/03-deploying-to-a-network.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

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

Thanks for teaching me why we add the ts code in comments, the tutorial runner needs it.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants