Update docs with v2.2 core changes

sablier-labs / docs

Documentation and guides for Sablier

https://docs.sablier.com

GNU General Public License v3.0

14 stars 7 forks source link

Update docs with v2.2 core changes #133

Closed smol-ninja closed 5 days ago

smol-ninja commented 3 months ago

In preparation for v2.2, docs should be updated with the following new information regarding changes with the core contracts.

Technical Reference

Overview

[x] Add LockupTranched and remove Comptroller

Diagrams

[x] Add lockup tranched section

Guides

Create a Stream

[x] Review Lockup Linear and Lockup Dynamic
[x] Add Lockup Tranched

Stream management

[x] Update withdraw from stream section with new changes

Hooks

[x] Update functions name of recipient hook
[x] Add a new section about sender hook

Miscellaneous

[x] Review Etherscan
[x] Review snapshot strategies

Concepts

[x] New section on LockupTranched under type of streams
[x] Add a new page about Tranches or combine it into Segments
[x] Remove protocol fees from Fees
[x] Remove Governance entirely
[x] Update Glossary

PaulRBerg commented 3 months ago

beautiful

andreivladbrg commented 3 months ago

Very nice organized Shub

Small note: we will need to update the diagrams, and may use other tools(like diagrams.net) instead of mermaid.js, how we did in airstream concept page

PaulRBerg commented 3 months ago

What's wrong with Mermaid? It's pretty cool to keep the diagrams in version control.

andreivladbrg commented 3 months ago

What's wrong with Mermaid?

the problem with mermaid is that it's super limited in how you can customize them

It's pretty cool to keep the diagrams in version control

yeah, they are very useful. i haven't said to remove them, but to update them according to the new storage layout:

Lockup -> common storage
LockupLinear -> cliffs
LockupDynamic -> segments
LockupTranched -> tranches

i doubt that mermaid will have the bandwidth to represent these accurately and beautifully

PaulRBerg commented 3 months ago

the problem with mermaid is that it's super limited in how you can customize them ... i doubt that mermaid will have the bandwidth to represent these accurately and beautifully

Fair

andreivladbrg commented 3 months ago

Leaving this here, maybe it would be helpful:

diverse1 drawio

smol-ninja commented 3 months ago

@andreivladbrg what do you think about visualising storage layouts like these? Re Diagrams