mangrovedao/mangrove.js

mangrove.js README.md examples don't work

espendk opened this issue · 2 comments

espendk commented

Some of the examples in the mangrove.js README.md no longer work and the output (when bugs are addressed) does not match the actual output, eg https://github.com/mangrovedao/mangrove-ts/tree/master/packages/mangrove.js#obtaining-a-market-object

To Reproduce
Copy-paste the example code into a node REPL.

Additional context
Would be great if examples would be checked as part of CI so drifts like this would be caught.

Or maybe the examples could be in actual code files (along with CI checks of that code) and then be included in the README.
GitHub has no native support for this, but there are GitHub Actions that will do this: https://github.com/marketplace/actions/markdown-embed-code-from-file

peterMangrove commented

@dontrolle Should the README.md not just link to our docu site?

dontrolle commented

The README should contain approx the info that it does now.

I edited the README as we created docs.mangrove.exchange, and I view this issue as deprecated. I'm closing the issue. @espendk reopen if you disagree.

  • 👍1