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.

Sign up for GitHub

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

Jump to bottom

Add a guide for the "sandbox boxes" in the docs. #2314

Closed
Tracked by #2658
iAmMichaelConnor opened this issue Sep 15, 2023 · 1 comment · Fixed by #2569
Closed
Tracked by #2658

Add a guide for the "sandbox boxes" in the docs. #2314

iAmMichaelConnor opened this issue Sep 15, 2023 · 1 comment · Fixed by #2569
Assignees
@critesjosh
Labels
A-documentation Area: relates to documentation

Comments

@iAmMichaelConnor
Copy link
Contributor

iAmMichaelConnor commented Sep 15, 2023 •
edited
Loading

Thanks to @dan-aztec's work, we can now unbox a neat private token contract.
https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/boxes/private-token/README.md

We should add a section in the docs describing this, and how to use it. Maybe in the dev-docs/getting-started dir?

@critesjosh @catmcgee perhaps your team might be best placed to do this?
@iAmMichaelConnor iAmMichaelConnor added the A-documentation Area: relates to documentation label Sep 15, 2023
@iAmMichaelConnor iAmMichaelConnor added this to the 📢 Initial Public Sandbox Release milestone Sep 15, 2023
@critesjosh critesjosh self-assigned this Sep 15, 2023
@critesjosh
Copy link
Contributor

critesjosh commented Sep 26, 2023 •
edited
Loading

Related, consider updating existing guides/tutorials to use aztec-cli unbox command to get a structured project to start with. (noting here for myself)

@critesjosh critesjosh mentioned this issue Sep 28, 2023
Merged
4 tasks
@critesjosh critesjosh mentioned this issue Oct 5, 2023
Closed
catmcgee pushed a commit that referenced this issue Oct 26, 2023
@critesjosh
feat: Add Aztec Boxes page to docs (#2569)
997c15c 
This PR adds a new page to the Getting Started section of the developer
docs about the Aztec Boxes. It goes through the basic "blank" box to
explain the basics.

It also makes some edits and formatting updates to a few pages.

Waiting on a few updates to the blank box from @dan-aztec. 

Also considering updating the Sandbox getting started guide to use the
private-token box to reduce amount of copy+paste required--although may
be more confusing than helpful given the amount of extra stuff included
in the box.

Closes #2314.

# Checklist:
Remove the checklist to signal you've completed it. Enable auto-merge if
the PR is ready to merge.
- [x] If the pull request requires a cryptography review (e.g.
cryptographic algorithm implementations) I have added the 'crypto' tag.
- [x] I have reviewed my diff in github, line by line and removed
unexpected formatting changes, testing logs, or commented-out code.
- [x] Every change is related to the PR description.
- [x] I have
[linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
this pull request to relevant issues (if any exist).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@critesjosh critesjosh

Labels
A-documentation Area: relates to documentation
Projects
A3
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Add Aztec Boxes page to docs AztecProtocol/aztec-packages
2 participants
@critesjosh @iAmMichaelConnor