search

sablier-labs / v2-merkle-api

https://v2-services.vercel.app
GNU General Public License v3.0
4 stars 1 forks source link

LInk to documented routes and logic in the official Sablier Docs #28

Closed razgraf closed 7 months ago

razgraf commented 8 months ago

The documentation from this repository's README.md should be moved to the official docs.sablier.com website.

Apart from the routes and the setup instructions, a series of architectural explanations (e.g. the flow from create-to-claim, the vercel vs. warp choices etc.) would be a great addition especially for people looking to fork this repository and apply certain changes or optimizations on top of it (e.g. optimize it only for a certain campaign and host it on their own).

razgraf commented 8 months ago

Related: https://github.com/sablier-labs/v2-docs/issues/120

razgraf commented 7 months ago

Update: the official docs.sablier.com have a new section all about this Merkle API.

The README should be updated to link to https://docs.sablier.com/api/merkle-api/intro (should only keep vital info and point to the docs for anything else).