onflow / onflow/flow

Update Documentation Hierarchy

Open
#352 5 comments 0 reactions 3 assignees View on GitHub

@psiemens is already working on this.

Since Feb 16, 2021.

Developer Tool Team Docs Site Document P-High
Dominant language
Go
Stars
361
Forks
159
PR merge metrics
No merged PRs in 30d

Description

Context

Docs.onflow.org needs a hierarchy that serves each of Flow's audiences, which currently include:

  • People who want to build experiences and communities on Flow
  • FLOW backers who are excited to learn more about what it means to access and participate in the Flow ecosystem and its rich communities
  • People who want to participate in securing and operating the network by running a node.
  • People who generally want to know more about the Protocol
  • People who generally want to know more about Cadence

Proposed Docs Site Structure - WIP

Community

Welcome to the Team

Standards & Expectations

Resources

Guide: Sharing Feedback & Airing Grievances
Directory: Communication Channels
  • Multiple language support
FAQs

Using Flow & FLOW

Introduction

  • What is FLOW?
  • How and where do I use FLOW?
  • Why do I need it?

Experiences

Directory: Launch Calendar

Staking & Delegating

  • Reference Reward Schedule & Calculation
Flow Port

Voting

Resources

Guide: Creating a Flow account
Guide: Staking & Delegating on Flow
Block Explorers
Account Management
  • Accounts & Profiles on Flow
  • User Agency on Flow
FAQs
  • How do I earn FLOW?

Building on Flow

Introduction

What are Flow and Cadence designed for?
Why does that matter and why are people excited?

Defining your Experience

Flow Product Matrix
Playground + Tutorials

Developing & Deploying your Experience

Stack Map

"not just how to build an NFT and an NFT marketplace but how to offer these via website/mobile app via the Dapper Wallet or otherwise. Anything that connects all the dots would be fantastic."

Installing CLI
Using Emulator & VS Code Extension
Access Node
Testnet & Mainnet

Sharing your Experience with Users

Flow Client Library (FCL)
Fees & Managing Accounts
FLOW & FUSD

Resources

Guide: Deciding to Build on Flow

https://github.com/onflow/flow/issues/351

Flow Product Matrix
Guide: Building a Dapp - Kitty Items
Directory: Example Dapps
Directory: Launch calendar
FAQs

Participating in Flow Network Operation

Introduction

Architecture Overview

Epochs

Rewards & Slashing

Resources

Node Requirements
Guide: Node Operator Quick Start
Directory: Existing Node Operator
FAQs

Flow Protocol

  • Link to technical papers

Cadence

  • Language spec
  • Tutorials

Definition of Done

  • Update docs site structure to match what's decided
  • Create content needed to fill the gaps the new structure reveals in existing documentation
  • Gather feedback on improved info gathering
Key Resources
  • Guides
  • Directories
  • FAQs

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.