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

web3.storage-tutorials-docs.md #117

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions proposals/filecoin-strorage-tutorials-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# filecoin.storage tutorials & docs

Authors: @atopal

## What is the problem this project solves?
Documentation, sample code and tutorials for dApp developers who want to build on top of filecoin.storage. A simple to use client library for Filecoin is crucial for those who want to adopt Filecoin for dApp storage. Since even many dApp developers are not well versed in decentralized storage, developers need great docs that contextualize the API reference, explain concepts and give examples for how to solve specific problems in code.

## Impact
This project aims to impact the goals of:
* Time from zero to simple dapp on the w3stack
* Increasing the number of off-chain dapps using Filecoin for storage/retrieval

## The idea
* API docs
* Sample code
* Tutorials (step-by-step walkthroughs)
* Conceptual docs
* Project examples

## Success/acceptance criteria (optional)
* APIs fully documented
* First round of sample code and tutorials are published
* Docs are user tested for the tutorials
* Continuous feedback for docs is available

## Detailed plans (optional)
https://www.notion.so/protocollabs/filecoin-storage-tutorials-docs-41d9cd9ed170416e8b4c48192b5f6b02


## Program (optional)
[Filecoin.storage](https://github.com/protocol/web3-dev-team/pull/110/files)