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

Aztec Docs: Add "intermediate" level intros to the top of docs pages #2561

Closed
14 tasks done
Tracked by #2658
critesjosh opened this issue Sep 27, 2023 · 0 comments
Closed
14 tasks done
Tracked by #2658

Aztec Docs: Add "intermediate" level intros to the top of docs pages #2561

critesjosh opened this issue Sep 27, 2023 · 0 comments
Assignees
@critesjosh @catmcgee
Labels
A-documentation Area: relates to documentation

Comments

@critesjosh
Copy link
Contributor

critesjosh commented Sep 27, 2023 •
edited by catmcgee
Loading

Learning to build on Aztec requires learning a lot of new info. Many of our current docs pages are walls of text the go quite deep into the specific details of the protocol.

Create an "intermediate" level section at the top of the following docs pages to make the information easier to parse and more digestible. This section should include a tldr that provides an overview of why the page is important and ideally a bulleted list of key points that will be explained in the page.

Tasks
Preview Give feedback
@critesjosh critesjosh added the A-documentation Area: relates to documentation label Sep 27, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Sep 27, 2023
@catmcgee catmcgee self-assigned this Sep 27, 2023
@critesjosh critesjosh mentioned this issue Sep 29, 2023
Merged
4 tasks
@catmcgee catmcgee changed the title Add "intermediate" level intros to the top of docs pages Docs: Add "intermediate" level intros to the top of docs pages Sep 29, 2023
@critesjosh critesjosh self-assigned this Oct 3, 2023
@critesjosh critesjosh mentioned this issue Oct 4, 2023
Closed
@signorecello signorecello changed the title Docs: Add "intermediate" level intros to the top of docs pages Aztec Docs: Add "intermediate" level intros to the top of docs pages Oct 9, 2023
@signorecello signorecello added A-documentation Area: relates to documentation and removed A-documentation Area: relates to documentation labels Oct 9, 2023
catmcgee added a commit that referenced this issue Oct 20, 2023
@critesjosh @catmcgee
feat: Incorporate docs feedback and add "intermediate" level intros t…
78f9f52 
…o some pages (#2598)

Learning to build on Aztec requires learning a lot of new info. Many of
our current docs pages are walls of text the go quite deep into the
specific details of the protocol.

Create an "intermediate" level section at the top of the following docs
pages to make the information easier to parse and more digestible.

This PR also includes feedback on overall docs structure and general
editing.

Closes issue #2561 

# 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: Cat McGee <[email protected]>
@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Oct 24, 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

No branches or pull requests
3 participants
@critesjosh @signorecello @catmcgee