From 82ce95046ea97e8e3730f3ddedc75b914424abff Mon Sep 17 00:00:00 2001 From: Kadir Topal Date: Mon, 21 Jun 2021 22:57:14 +0200 Subject: [PATCH] Create filecoin-strorage-tutorials-docs.md Initial draft of filecoin.storage docs. More details in the Notion doc: https://www.notion.so/protocollabs/filecoin-storage-tutorials-docs-41d9cd9ed170416e8b4c48192b5f6b02 --- proposals/filecoin-strorage-tutorials-docs.md | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 proposals/filecoin-strorage-tutorials-docs.md diff --git a/proposals/filecoin-strorage-tutorials-docs.md b/proposals/filecoin-strorage-tutorials-docs.md new file mode 100644 index 00000000..46276a26 --- /dev/null +++ b/proposals/filecoin-strorage-tutorials-docs.md @@ -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)