We received feedback on discord from one of our community members about the GDA section on the docs:
"Here's a possible project idea for a Guild member: improved developer docs for Distributions (GDA).
I have mentioned this on 2 separate occasions in the past, and while I have received helpful responses from the SF team, the docs remain incomplete wrt distribution pools. Each time I have wanted to start playing with them, I have become blocked by incomplete/vague docs. And if I am getting blocked -- as someone with superfluid dev experience -- you can be sure that devs new to SF are getting blocked. The key thing missing is the end-user perspective. When should claimAll() be called, and by whom? When should connectPool() be called, and what does connecting to a Pool actual mean? And how is it different from claimAll()? I have searched, and the docs don't seem to have answers to these critical questions. You cannot create a dapp (incl. front-end) without understanding the answers. I think an end-to-end Alice&Bob type example would be really helpful, outlining all the players, the functions, and the sequence of events between pool creation, adding members, starting a dist flow, connecting/disconnecting, claiming, etc.
The above isn't meant to be a rant. Rather it seems like an opportunity (that is currently being missed) to encourage devs to build on distribution pools. I am not sure if this is a good fit for any Guild members, or better suited to a SF team member, but either way, I think it would be a valuable contribution to the Superfluid ecosystem."
Following this feedback, the docs need to be amended to include:
An explanation of pool connection vs claiming details
Examples to illustrate the differences as well as the steps needed for the user journey around distribution pools
Context:
We received feedback on discord from one of our community members about the GDA section on the docs:
"Here's a possible project idea for a Guild member: improved developer docs for Distributions (GDA).
I have mentioned this on 2 separate occasions in the past, and while I have received helpful responses from the SF team, the docs remain incomplete wrt distribution pools. Each time I have wanted to start playing with them, I have become blocked by incomplete/vague docs. And if I am getting blocked -- as someone with superfluid dev experience -- you can be sure that devs new to SF are getting blocked. The key thing missing is the end-user perspective. When should claimAll() be called, and by whom? When should connectPool() be called, and what does connecting to a Pool actual mean? And how is it different from claimAll()? I have searched, and the docs don't seem to have answers to these critical questions. You cannot create a dapp (incl. front-end) without understanding the answers. I think an end-to-end Alice&Bob type example would be really helpful, outlining all the players, the functions, and the sequence of events between pool creation, adding members, starting a dist flow, connecting/disconnecting, claiming, etc.
The above isn't meant to be a rant. Rather it seems like an opportunity (that is currently being missed) to encourage devs to build on distribution pools. I am not sure if this is a good fit for any Guild members, or better suited to a SF team member, but either way, I think it would be a valuable contribution to the Superfluid ecosystem."
Following this feedback, the docs need to be amended to include: