Strategems.jl icon indicating copy to clipboard operation
Strategems.jl copied to clipboard

Documentation

Open dysonance opened this issue 6 years ago • 3 comments

Need to write more thorough documentation for package functionality.

  • Examples
    • Full walkthrough
    • Universe data gathering usage
  • New infix operators
    • Crossover alias (up arrow)
    • Crossunder alias (down arrow)

dysonance avatar Oct 26 '17 05:10 dysonance

Might also be a good idea to get a wiki started with some proper walkthroughs and more in-depth explanations.

dysonance avatar Oct 27 '17 02:10 dysonance

I guess it should be enough with a single one made with Documenter.jl. It works pretty well and it is easy to use. Check some examples to see if that could work for this package

  • http://www.juliaopt.org/JuMP.jl/v0.21.1/
  • https://gadflyjl.org/stable/
  • https://leferrad.github.io/OCReract.jl/dev/ (I made this one and it was extremely easy)

leferrad avatar Jun 02 '20 23:06 leferrad

bump, I can try to put up some docks with Documenter; can you make a TODO list or "wish list" for what to include?

Moelf avatar Aug 18 '20 23:08 Moelf