search

BlockPo / BlockPo-to-Tradelayer

Incubation Repo for the TradeLayer protocol, 0.2.0
http://www.tradelayer.org
Other
8 stars 8 forks source link

Basic docs #103

Closed santos177 closed 2 years ago

santos177 commented 4 years ago

Related with rpcs calls. Basic info to show : use, syntax, expected response.

patrickdugan commented 3 years ago

I made a YAML of an API that we dind't ultimately take public, in June 2020, that maps a lot of the RPCs. I'll need to dig that out of the old laptop. But a simple .md file that extends the OmniLayer one is a good idea. I also wrote out a spec that lists them, here it is:

https://docs.google.com/document/d/1ppokG076_4TwlMnRBHWFd3iG_NvYfvIM9kx795QhMts/edit

So that is missing the new RPCs but it's a start to making this .md file and having it publicly linked to on the website ideally. Maybe not as a main header but include a link on the About page.

patrickdugan commented 2 years ago

I started some Basic design doc with a github pages on my fork. Should circle back to post-mortem this project. API documentation is more essential now as we shove off of the dock.