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: separate walkthrough tutorials from diataxis learning tutorials #8853

Open
Tracked by #220
jzaki opened this issue Sep 27, 2024 · 0 comments
Open
Tracked by #220

docs: separate walkthrough tutorials from diataxis learning tutorials #8853

jzaki opened this issue Sep 27, 2024 · 0 comments
Assignees
Labels
A-documentation Area: relates to documentation C-docs Component: docs.aztec.network

Comments

@jzaki
Copy link
Contributor

jzaki commented Sep 27, 2024

Most flows in the tutorials section can be completed with the reader simply copy/pasting each step.

The Crowdfunding tutorial is designed to teach.
"The first rule of teaching is simply: don’t try to teach. Your job, as a teacher, is to provide the learner with an experience that will allow them to learn. A teacher inevitably feels a kind of anxiety to impart knowledge and understanding, but if you give into it and try to teach by telling and explaining, you will jeopardise the learning experience.

Instead, allow learning to take place, and trust that it will. Give your learner things to do, through which they can learn. Only your pupil can learn." - https://diataxis.fr/tutorials/

This difference in cadence can be communicated by having...

Tutorials:

Walkthroughs:

  • Counter
  • Private voting
  • accounts
  • private/public token
@jzaki jzaki added the A-documentation Area: relates to documentation label Sep 27, 2024
@jzaki jzaki self-assigned this Sep 27, 2024
@github-project-automation github-project-automation bot moved this to Todo in A3 Sep 27, 2024
@iAmMichaelConnor iAmMichaelConnor added the C-docs Component: docs.aztec.network label Oct 2, 2024
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 C-docs Component: docs.aztec.network
Projects
Status: Todo
Development

No branches or pull requests

2 participants