onflow / onflow/flow

Documentation suggestions

Open
#670 3 comments 1 reaction 3 assignees View on GitHub

@bebner is already working on this.

Since Oct 19, 2021.

Document Feedback
Dominant language
Go
Stars
361
Forks
159
PR merge metrics
No merged PRs in 30d

Description

Here are some documentation gaps I have found while developing.

Flow Building Blocks
There is no document describing "flow entities" in language-agnostic and easy-to-understand terms. Entities that make the Flow network such as:

  • accounts,
  • blocks,
  • transactions,
  • collections,
  • networks,
  • nodes

It would be great to have a page for each of those entities where we would describe what the entity is, what role does it play on the network, how it gets created and how you interact with it etc all that language agnostic. Something similar to: https://ethereum.org/en/developers/docs/accounts/ or https://ethereum.org/en/developers/docs/transactions/
An example of questions this document would answer:

  • What are possible transaction statuses and what they mean,
  • What is the purpose of each Flow network (mainnet, testnet, canarynet, emulator),
  • How are accounts created etc etc

Hello Flow
A quick introduction for newcomers about the Flow concepts. Slimmed-down version of https://www.onflow.org/primer with easy to understand explanation of concepts. It would include titles such as: What is Flow? What is Flow token? How Flow works (multi-node arch), What is smart contract / Cadence?

Cadence by Example / Tour of Cadence
A document that offers a similar experience for learning to how you learn Go (by example) https://tour.golang.org/welcome/1 (it doesn't need to be interactive, as long as it's an example with explanation of concepts used is good enough). Another great example is Solidity: https://solidity-by-example.org/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.