sablier-labs / docs

Documentation and guides for Sablier
https://docs.sablier.com
GNU General Public License v3.0
14 stars 7 forks source link

Add new curves in "Types of Streams" #110

Closed PaulRBerg closed 2 months ago

PaulRBerg commented 8 months ago

We've introduced four new curves in the UI, but we haven't updated the Types of Streams page to include them.

andreivladbrg commented 3 months ago

Isn't the current unlock-in-steps pretty much the same with "Monthly Unlocks"? @PaulRBerg

PaulRBerg commented 3 months ago

@andreivladbrg kind of but not really.

  1. MU should contain month names on the X axis.
  2. UiS can do more than MU, so we should update UiS to highlight this extra flexibility. For instance, days or weeks.
andreivladbrg commented 3 months ago

kind of but not really

IMO, MU is just a subset of UiS

currently, the FunctionPlot component displays "time" on the X axis, not specifying the unit (days/weeks/months)

which do you think is better (or other suggestions):

PaulRBerg commented 3 months ago

MU is just a subset of UiS

Yes, which means that they are not the same thing.

FunctionPlot component displays "time" on the X axis

So is it not possible to display something else?

change the component or add another that specifically labels the X axis as "months"

This

andreivladbrg commented 3 months ago

yes, they are not the same thing, but since $MU ⊆ UiS$ why not include some comments about MU at the UiS shape, can't we do this?

So is it not possible to display something else?

yes it is possible, but it requires to change the current function or to implement a new one

https://github.com/sablier-labs/docs/blob/11600fadf63bf895efd5872b9bca3d3a3ffc21e6/src/components/FunctionPlot.tsx#L18

PaulRBerg commented 3 months ago

why not include some comments about MU at the UiS shape, can't we do this?

The masses like concrete examples. They do not think mathematically.

The documentation site is meant to dumb down Sablier.

it requires to change the current function or to implement a new one

Let's do it

andreivladbrg commented 3 months ago

The masses like concrete examples. They do not think mathematically documentation site is meant to dumb down Sablier

i agree that the masses like concrete examples, and that's why we include them at the interface level.

however, my understanding was that the documentation site is intended for developers, who are presumably technical. if that's not the case (if it's not specifically for developers) then i agree

PaulRBerg commented 3 months ago

developers like concrete examples, too

andreivladbrg commented 3 months ago

so, you're saying that keeping UiS, along with comments on how this method can achieve monthly unlocks, does not represent a concrete example for developers - fair enough

how should the curve look like? same number of unlocks as UiS, or less/multiple?

PaulRBerg commented 3 months ago

Yes

how should the curve look like? same number of unlocks as UiS, or less/multiple?

I answered this in a comment above. We should make it different (fewer, more, it doesn't matter) so that they are visually differentiable

smol-ninja commented 3 months ago

After V2.2, wouldn't we use Lockup Tranched to create unlock-in-steps and unlock-each-month streams in the UI? If yes, then why are we including them to Lockup dynamic section in doc?

andreivladbrg commented 3 months ago

You are right Shub, thanks for pointing out. These shapes will be placed under Lockup Tranched section after v2.2 docs update.