sablier-labs / flow

🍃 Smart contracts of the Sablier Flow protocol.
Other
8 stars 0 forks source link

docs: refactor technical doc #314

Open smol-ninja opened 3 days ago

smol-ninja commented 3 days ago

Refactors technical doc in line with https://github.com/sablier-labs/flow/pull/312.

smol-ninja commented 3 days ago

@andreivladbrg so after the new update, the unlock interval takes into account the last withdraw time ($wt$) and not snapshot time ($st$) anymore. Thats what the PR is about.

I've updated the content. Without changing the numbers we can say that time values are considered since last withdraw time and not the last snapshot time. This will require updating the charts with the new labels.

Alternatively, I am in favour of removing the numbers and charts and only keep the theory part in brief to understand the precision problem. This is due to the fact that with numbers and charts, the cost of maintenance of the technical doc is non-zero. The purpose of the doc is to explain delays and precision issues in calculations of withdrawn amount which imo is already well explained. What do you think?