bbgo icon indicating copy to clipboard operation
bbgo copied to clipboard

documentation: strategies

Open zenixls2 opened this issue 2 years ago • 3 comments

add documentation in each of the strategy folder

  • strategy abstraction
  • strategy details (implementation wised)
  • consumed data
  • error messages
  • expected behavior (raise several examples, including the sample input and expected results)
  • parameter explanation

Prefer to have documentation in markdown.
If the documentation is already carefully written inside strategy.go, better to link users to the generated godoc page of that strategy.

I'll provide 500 BBG for this issue.
feel free to add any to the bounty pool. cc @c9s @tony1223

zenixls2 avatar Dec 28 '21 01:12 zenixls2

👍

c9s avatar Dec 28 '21 03:12 c9s

FYI The documentation's abstraction and expected behavior parts will finally be exported to bbgo's website.

zenixls2 avatar Dec 28 '21 04:12 zenixls2

I can provide help with this (review, formatting, finding graphics) if somebody asks. Also I'm potentially ready to help by paying whomever, using crypto (though I don't own BBG, but if somebody is ready to sell me some or pay "for" me using BBG I'd be open to that)

arthurwolf avatar Jan 10 '22 15:01 arthurwolf