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

Review the monorepo README #1905

Closed
iAmMichaelConnor opened this issue Aug 30, 2023 · 1 comment · Fixed by #2322
Closed

Review the monorepo README #1905

iAmMichaelConnor opened this issue Aug 30, 2023 · 1 comment · Fixed by #2322
Assignees
@critesjosh @catmcgee
Labels
A-documentation Area: relates to documentation

Comments

@iAmMichaelConnor
Copy link
Contributor

Is the information still current?
Is it informative enough for a new person to understand?
Does it explain what Aztec is, or where to get more information?
Does it explain everything that the repo contains?
Etc.
@iAmMichaelConnor iAmMichaelConnor added the A-documentation Area: relates to documentation label Aug 30, 2023
@iAmMichaelConnor iAmMichaelConnor added this to the 📢 Initial Public Sandbox Release milestone Aug 30, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Aug 30, 2023
@critesjosh
Copy link
Contributor

being addressed in #2322

@critesjosh critesjosh mentioned this issue Sep 18, 2023
Merged
4 tasks
critesjosh added a commit that referenced this issue Sep 19, 2023
@catmcgee @critesjosh
chore: docs restructure (#2322)
1368b55 
- Removed some things from the sidebar that were empty/WIP
- Filled out 'how to participate' and 'visibility' sections
- Changed around structure to make it easier to follow
- use #include_code macro to pull in code from tests for getting started
page
- closes #1905 
# Checklist:
Remove the checklist to signal you've completed it. Enable auto-merge if
the PR is ready to merge.
- [ ] 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.
- [ ] Every change is related to the PR description.
- [ ] 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 <[email protected]>
Co-authored-by: Josh Crites <[email protected]>
@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@critesjosh critesjosh

@catmcgee catmcgee

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.

chore: docs restructure AztecProtocol/aztec-packages
3 participants
@critesjosh @catmcgee @iAmMichaelConnor