On Thu, Jan 24, 2013 at 4:16 PM, Sean P. DeNigris
<sean@clipperadams.com> wrote:
I eventually found this awesome website [1]. It would be great if there were
some basic examples in the image. I found the tests too well factored to be
used for this purpose.
what do you mean by this?
FLUserGuidesTest contains the examples used in the website (although there may not be everything and still it could be outdated).
Maybe we can move this test into a Fuel-Examples package?
�
Even a HelpSystem entry simply pointing to [1] would
be really helpful for beginners like me ;) (although a full Help entry would
have the nice benefit of executable examples)
Hi Sean. One problem I found is that then we have too many places with the same doc. Hence, a simple update means changing a lot of places:
- Doc in image
- Examples in image / tests
- Website
- Help system
- PBE chapter
so...that does not scale.�
I don't know yet the best way to solve this. Markdown and then output all the different pieces is not an option I think.
thoughts?
�
Thanks,
Sean
[1]
http://rmod.lille.inria.fr/web/pier/software/Fuel/Version1.8.1/Documentation
--
View this message in context: http://forum.world.st/In-Image-Fuel-Documentation-tp4665190.html
Sent from the Pharo Smalltalk mailing list archive at Nabble.com.