Docs: Collect ideas for onboarding "quest" progression
jimpick opened this issue · 6 comments
In the docs, there will be a "Getting Started" section, which should help people to "get their feet wet" with the JS Client in the easiest way possible.
Beyond that, there should be a series of exercises (aka "quests") that guide the developers through various parts of the API that they'll need to learn in order to build things. As they proceed through the progression, they will learn the basics of the API plus gain knowledge about how Filecoin is organized. Later exercises will require prerequisite knowledge from earlier exercises. Earlier quests will be things that most developers will want to do, whereas later quests might only appeal to a smaller audience that is trying to do advanced, niche things.
Planning out the progression will assist efforts to prioritize where to spend development time as we build the Lotus JS Client. A fully developed quest will have good support in the library, unit tests, documentation and example code / demos.
I'll add some ideas for quests in follow-on comments.
Initial ideas for "quests":
- Learn about the JSON-RPC API with curl and wscat
- Connecting to a node and querying the
Version
method - Getting the chain height
- Querying the chain state
- Getting status of the miner and sectors
- Pledging sectors
- Getting wallet balances
- Querying asks
- Importing files
- Making deals
- Checking deal status
- Finding deal error information
- Retrieving data
- Messages: signing, message pools
- Sending funds between accounts
- Payment channels
- Actors
A good quest might be "build a block explorer"...
There are probably several existing ones we can look at, for example:
Some quests/demos that do visualization with frameworks like D3 or Deck.gl would be fun.
Here's a visualization that @jbenet did for Filecoin a few years ago:
Maybe a section on how to build/integrate a third-party wallet would be good?
Let's start with number 2.
After working on #29 ... I realize we should add a module/quest for the markets part of the API ... there's a whole bunch of behaviour relating to storage markets and retrieval markets which is available via the API:
https://filecoin-project.github.io/specs/#systems__filecoin_markets