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

Relate the CLI getting started guide to the contract being executed #2188

Closed
Tracked by #2658
iAmMichaelConnor opened this issue Sep 11, 2023 · 3 comments
Closed
Tracked by #2658
Labels
A-documentation Area: relates to documentation T-feedback Type: recording user feedback

Comments

@iAmMichaelConnor
Copy link
Contributor

iAmMichaelConnor commented Sep 11, 2023

Some user feedback:
"
It would be nice to see a code snippet of the noir script used in the example. I think it would be a great opportunity to explain the primitives / quirks of noir so I can fully understand what is happening when I am transferring crypto from Alice to Bob.
The sandbox is somewhat underwhelming once i got it working. the noir script code snippet would fix this! I wanna know what is happening.
"

In dev_docs/getting_started/cli, provide code snippets of the relevant functions that will be executed. Provide links to elsewhere in the docs for explanations about the syntax. Also provide a link to the section of the docs which explains how to write a noir contract.

To reduce clutter, we should collapse the noir contract code snippets into an expandable section, using https://docusaurus.io/docs/markdown-features#details .

@iAmMichaelConnor iAmMichaelConnor added the A-documentation Area: relates to documentation label Sep 11, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Sep 11, 2023
@iAmMichaelConnor iAmMichaelConnor added the T-feedback Type: recording user feedback label Oct 23, 2023
@iAmMichaelConnor
Copy link
Contributor Author

@critesjosh I'm going through old issues that I opened, that might have been missed. Just pinging you if this is still relevant? If not, please feel free to close it :)

@critesjosh
Copy link
Contributor

We'll consider updating in the PR mentioned above.

@critesjosh
Copy link
Contributor

There is a lot more accessible content and links have been added to relevant sections for people that want to learn more.

@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: relates to documentation T-feedback Type: recording user feedback
Projects
Archived in project
Development

No branches or pull requests

2 participants