Closed pbrehmer closed 1 year ago
I also have some feedback we could talk about.
Most importantly I feel you are assuming people read the docs from front to back, but spoiler: They won't. Make sure each docs page is self-contained or directly references a page where the basic aspect you are building on is explained. In particular don't hide code. Some people will just copy and paste and walk away frustrated if it does not just work.
Yes that's a very good point. The point of hiding code was to show that only certain steps in the offline phase have to be changed to customize the solver etc., while all of the online procedure stays the same.
Now with Literate
I won't hide any code and just remark on the bits that previous examples have already covered, to highlight this.
PR #37 fixed most of these things. What's left to do is:
And additionally to get the docs to a good "preliminary state":
result
to rbres
, remove unnecessary kwargs, ...)
There are a few things, that could be improved and added:
Literate.jl
to avoid code duplication with respect to examples/* (see also #15)