superfluid-finance / docs Goto Github PK
View Code? Open in Web Editor NEWDocumentation for the superfluid protocol.
Documentation for the superfluid protocol.
In https://docs.superfluid.finance/superfluid/developers/super-tokens/deploy-a-super-token/deployment#deploying-using-block-explorer InterfaceImplementerSet should be replaced by SuperTokenCreated
SuperTokenCreated appears in https://basescan.org/tx/0x86c7b1e60d6e3de167d01cb34f8cc46965a317a70e44813123e9b1f33cd7498e#eventlog and https://polygonscan.com/tx/0xd23df49ac21f5c92049ede689e835d5dcbbd3c9670428ce7dd22f391fd5f9564#eventlog
InterfaceImplementerSet doesn't appear in https://basescan.org/tx/0x86c7b1e60d6e3de167d01cb34f8cc46965a317a70e44813123e9b1f33cd7498e#eventlog
Ask Anett for clarification.
Ask Miao to setup admin credentials.
First step, all-in-one script:
Second step:
admin.flow(bob, 100)
Third step:
show link to stream page
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
There is no instruction on how to install the superfluid library before implementation. This could pose an issue for beginners.
As a protocol developer, I'd like a quick tutorial for the new subgraph v1 helping me to start using it.
Current version is at https://docs.superfluid.finance/superfluid/docs/subgraph
A new version could be hosted at https://docs.superfluid.finance/superfluid/docs/subgraph-v1, and co-exist with the legacy version for a while (But set-up a sunsetting schedule in advance)
The semicolon is required after each line of code in Solidity.
However, in the Superfluid Solidity Docs, there is no semicolon after defining the compiler version.
Current code: pragma solidity ^0.8.0
Expected code: pragma solidity ^0.8.0;
Can you please enable dark mode. It's very tiring to read like this.
https://docs.gitbook.com/tour/customization/space-customization
Summary: People create Superfluid tutorials and Superfluid pays them.
A Superfluid Bounty Program already exists, you can just add tutorial and content bounties.
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:
It didn’t tell me what packages to install (related issue)
No indication that I needed a faucet to get xDAI and no instructions on how to get some
The CodeSandbox iFrame embed was too slow and too squished to use
Necessary Information was spread across multiple pages and there were no videos
Quickstart information should be all on one page with copy-paste friendly code
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.
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
I would love to do one of these bounties. Here are some of my qualifications:
How to Build a Multi-Chain NFT Marketplace (video, twitter thread)
How to add Ethereum & Binance Payments w/ React and Ethers.js (video)
How to Get Paid with Crypto Scholarships and Hackathons (video, twitter thread, tiktok)
Related to: superfluid-finance/protocol-monorepo#464
It should wait until "stream period" is released to the v1 subgraph.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.