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

[DIP 1: DIATAXIFY] Docs: Structure #108

Closed
8 of 11 tasks
critesjosh opened this issue Jan 10, 2024 · 4 comments
Closed
8 of 11 tasks

[DIP 1: DIATAXIFY] Docs: Structure #108

critesjosh opened this issue Jan 10, 2024 · 4 comments
Assignees

Comments

@critesjosh
Copy link
Collaborator

critesjosh commented Jan 10, 2024

This is an issue to track all of the desired changes for updating the docs. The context for the docs changes are going through the current docs and thinking about how we can improve them based on Learning Journeys.

Add issues here:

Tasks

  1. catmcgee
  2. Aztec Docs
    catmcgee
  3. catmcgee
  4. documentation
    catmcgee
  5. catmcgee
  6. Aztec Docs Noir Docs
    catmcgee jzaki
  7. documentation
    critesjosh
  8. critesjosh

Learning journey references:

@critesjosh
Copy link
Collaborator Author

A small piece of feedback that I'm not sure how to add to the list.

The docs talk about proving things. for smart contract devs, proving often means something different in zk land vs smart contract land. proving for Ethereum devs means revealing all of the data, not so for aztec

@critesjosh
Copy link
Collaborator Author

critesjosh commented Jan 24, 2024

Also, at the top of some pages, it says "you will learn X on this page". Consider adding "if you want to learn Y go to these pages", for the case where someone lands on that page that is actually looking for a related topic. The API pages be a good place to add these

@catmcgee catmcgee changed the title Learning Journey Docs Audit tracking issue Docs: Learning Journeys + Structure - Tracking Issue Jan 24, 2024
@catmcgee catmcgee changed the title Docs: Learning Journeys + Structure - Tracking Issue [TRACKING ISSUE] Docs: Learning Journeys + Structure Jan 24, 2024
@catmcgee catmcgee changed the title [TRACKING ISSUE] Docs: Learning Journeys + Structure [DIP 1: JOURNEY] Docs: Learning Journeys + Structure Jan 24, 2024
@catmcgee catmcgee changed the title [DIP 1: JOURNEY] Docs: Learning Journeys + Structure [DIP 1: DIATAXIFY] Docs: Structure Jan 24, 2024
@catmcgee
Copy link
Collaborator

You can find the new proposed structure on Notion

@critesjosh
Copy link
Collaborator Author

@catmcgee is this work carrying on into this week's iteration?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants