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

Tutorials and Guides for developers #15

Open
glasgowm148 opened this issue Oct 29, 2021 · 2 comments
Open

Tutorials and Guides for developers #15

glasgowm148 opened this issue Oct 29, 2021 · 2 comments

Comments

@glasgowm148
Copy link
Member

Ergo has lots of great dense resources and explanations - but needs people to make these understandable to people.

Tutorials are learning-oriented lessons that take the reader by the hand through a series of steps to complete a project.

The most important part of the documentation, and rarely done well.

What matters?

  • Learn by doing.
  • Getting Started
  • Inspiring Confidence
  • Repeatability
  • Immediate sense of achievement
  • Concreteness, not abstraction
  • Minimum necessary explanation
  • No distractions

How-To Guides are problem-oriented guides that take the user through a series of steps to achieve a common problem.

What matters?

  • A series of steps
  • A focus on the goal
  • Addressing a specific question
  • A little flexibility
  • Practical usability
  • Good naming

Bounties of upto 500 SigUSD can be awarded based on merit. Equally, submissions can be rejected if they're not suitable.

Examples will be added soon, please see this site in the meantime.

(live version http://docs.ergoplatform.org/ in a few days)

@OguzhanYi
Copy link

Hi Glasgow, I'd like to do a complete tutorial on using the Yoroi connector in two to three weeks as it still seems a bit a mystery for everyone in the community.

@Eeysirhc
Copy link

Eeysirhc commented Dec 6, 2021

PR Submission for Tutorial: Blockchain Explorer with Raspberry Pi

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

3 participants