GOR — Write Tutorials & Documentation

moul commented 1 year ago

Note: this issue will be updated to keep track of changes in rules.

Challenge Description

We are working to make Gnolang one of the easiest ways to write secure dApps in the future. But with today's state, only the most experienced developers can get started autonomously.

We need experienced devs to write or record tutorials to help more people get started during phase two of the competition (and beyond) and to help grow the Gno.land developer community.

What we look for in the submissions/suggestions on what could work for addressing the challenge

These tutorials can include topics like interacting with the chain from the CLI, step-by-step guides to creating smart contracts in Gno, tips for running a local dev environment, fast prototyping with gnodev, or they can be tutorials dedicated to certain audiences, such as developers coming from Solidity or web2.

All tutorials should be referenced on the awesome-gno GitHub repo.

What wins points

Idiomatic / well integrated — i.e, with go comments and generated outputs
High learning efficiency — the delta between before’s knowledge and after’s knowledge
Great UX — well-written, interactive, video, graphical
Text quality and clarity

Suggestions and examples (non-exhaustive):

Tips & Snippets -- https://github.com/gnolang/awesome-gno#tips--snippets (#540)
TDD & Fast smart-contract development with gnodev
Install a local testnet -> official issue: https://github.com/gnolang/gno/issues/478
ERC20 vs GRC20, a comparison of a well-known application; should also give examples of composability
Getting started template repo
Good practices & Design patterns
Porting existing contracts, applications, libraries to Gno
Getting started challenges to quickly discover advanced concepts
Gno concepts (https://github.com/gnolang/gno/issues/439#issuecomment-1408358842)
Improve existing docs/links organization (https://github.com/gnolang/gno/issues/499)

moul commented 1 year ago

Suggestions and examples (non-exhaustive):

TDD & Fast smart-contract development with gnodev
Install a local testnet -> official issue: #478
ERC20 vs GRC20, a comparison of a well-known application; should also give examples of composability
Getting started template repo
Good practices & Design patterns
Porting existing contracts, applications, libraries to Gno
Getting started challenges to quickly discover advanced concepts

-> updated in the main issue body

dongwon8247 commented 1 year ago

Made a PR to awesome-gno (https://github.com/gnolang/awesome-gno/pull/21), but sharing it here too.

Links for tutorial docs:

Github: https://github.com/onbloc/gnoland-tutorials
Gitbook: https://onbloc.gitbook.io/gnoland-developer-portal/ (The Github and Gitbook are synced)

Any feedback & suggestions for improvement is welcomed!

moul commented 1 year ago

We'd like to experiment with a quick&fast way to make small contributions on this topic: Tips & Snippets.

It could make sense to isolate those quick tips & snippets in a CSV file used to generate an HTML page with previews.

-> https://github.com/gnolang/awesome-gno/pull/22

moul commented 1 year ago

There is a task going on here that only requires web dev skills and no need for being good at writing tutorials.

See:

marriedjven commented 1 year ago

Hi, do you think this thread will be eligible for GOR or not? https://bitcoingarden.org/forum/index.php?topic=122418.0

gnolang / gno