Giter Club home page Giter Club logo

docs's People

Contributors

0xdavinchee avatar adwitm avatar bertux avatar christianbm1 avatar cypherhat avatar d10r avatar floar avatar hellwolf avatar iamsahu avatar kobuta23 avatar lucadgtrip avatar mdalie avatar ngmachado avatar omnifient avatar petertheone avatar pi0neerpat avatar rhyssf avatar saflamini avatar shih-yu avatar vmichalik avatar xlazer4 avatar yanhuijessica avatar youssefea avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Create two-step console demo

First step, all-in-one script:

  1. run a live goerli testnet instance
  2. create admin user()
  3. call the faucet, prefund local admin account
  4. upgrade daix
  5. create other users (alice, bob, carol)

Second step:
admin.flow(bob, 100)

Third step:
show link to stream page

SuperTokenCreated instead of InterfaceImplementerSet when searching in new SuperToken deployment

docs.superfluid.finance updates

TODOs:

  • add information about list of testnets supported (fran)

  • CFA tutorial update (Fran)

  • User Object tutorial (Fran)

  • IDA tutorial update (Pat)

  • merge the new tutorial texts

Proposal: Superfluid Content Bounties

Superfluid Content Bounty Proposal

Summary: People create Superfluid tutorials and Superfluid pays them.

A Superfluid Bounty Program already exists, you can just add tutorial and content bounties.

Why This is Important

Good documentation is important for onboarding users. For example, Stripe’s great documentation is a big reason why so many developers use it for web2 payments. Superfluid can be the Stripe of web3 payments documentation. More tutorials makes it easier for more people to use Superfluid in their projects which creates more material for tutorials and repeat. A powerful flywheel effect for getting more developers on Superfluid. More tutorials will also allow more bounties to get completed

I used the Superfluid Money Streaming API for my ETHNYC hackathon project. The Superfluid team that attended ETHNYC may remember the demo I gave to at your table, it was about Harberger Tax NFTs. I really love the idea of streamable money and I love what Superfluid is building. However, the documentation was very difficult to use. Here are just a few examples:

  1. It didn’t tell me what packages to install (related issue)

  2. No indication that I needed a faucet to get xDAI and no instructions on how to get some

  3. The CodeSandbox iFrame embed was too slow and too squished to use

  4. Necessary Information was spread across multiple pages and there were no videos

    1. Quickstart information should be all on one page with copy-paste friendly code

    2. Videos were on a separate section at the bottom and missing timestamps

Usually, when a more established software project lacks good official documentation, people will use the community tutorials. However, Superfluid’s nascentness means there’s currently a lack of community tutorials. Incentivising the community to create tutorials is an effective solution.

Deliverables

  • Blog post tutorial: (e.g. how to start, update and stop a Superfluid stream in React)

  • Optional: Video tutorial accompanying the blog post

  • Optional: Twitter Thread or similar social media post summarizing the tutorial

Examples of Past Tutorials I’ve Made

I would love to do one of these bounties. Here are some of my qualifications:

Future Ideas

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.