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: better getting started flow #2960

Closed
Tracked by #2658
catmcgee opened this issue Oct 22, 2023 · 0 comments · Fixed by #2957
Closed
Tracked by #2658

docs: better getting started flow #2960

catmcgee opened this issue Oct 22, 2023 · 0 comments · Fixed by #2957
Labels
A-documentation Area: relates to documentation

Comments

@catmcgee
Copy link
Contributor

No description provided.

@rahul-kothari rahul-kothari added the A-documentation Area: relates to documentation label Oct 23, 2023
catmcgee added a commit that referenced this issue Nov 2, 2023
Closes #2960

This PR
- [x] Restructures getting started / aztec.js / sandbox / cli content so
it's in an order that makes sense nothing is reused
- [x] Implements Diataxis philosophy in CLI, sandbox, aztecjs, and
getting started sections
- [x] Creates reference pages for CLI and Sandbox (any new stuff we dump
into there!)
- [x] Creates a basic getting-started guide for Aztec.nr (I know the
counter contract is very simple, but one thing I've learned from our
feedback partners & people in discord is that it helps a tonnn with
understanding syntax and has unblocked people. so i defo want it in our
docs. and it's fast to go through)
- [x] Creates new top level Updating page 

# 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.
- [ ] 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).

---------

Co-authored-by: Josh Crites <jc@joshcrites.com>
Co-authored-by: josh crites <critesjosh@gmail.com>
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants