Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.ruby > #7251

Tutorial creation Gem

Show all headers | View raw

Hi,

I was thinking to add some documentation to a RoR project of huge size, so my main concerns is that my documentation will soon get deprecated. I was thinking on a way to specify it in a tutorial way, like explaining with the documentation itself how to use the model of the project by interacting with the console, but at the same time I would like to keep this documentation as a group of tests in my project, so if my model changes, it will break the tests specified by the tutorial itself. In this way, anyone that maintains my project in future will need to keep up to date the tests from the tutorial, as they could be part of the testing suite for the project.

Does anybody know about any gem that could help to provide this type of functionality in a RoR project?

Many thanks

Back to comp.lang.ruby | Previous | Next | Find similar

Thread

Tutorial creation Gem edu.hast@gmail.com - 2016-05-18 11:35 -0700

csiph-web