<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><div>Hi.</div><div><br></div><div>We also just added another ticket type to our <a href="http://lively-kernel.org/trac">trac</a>: <i>documentation</i> request. </div><div><br></div><div>So, if there's a specific topic without any documentation in Lively (see <a href="http://www.lively-kernel.org/repository/webwerkstatt/documentation/">documentation/</a>, <a href="http://www.lively-kernel.org/repository/webwerkstatt/documentation/livedoc/">livedoc/</a>, ... here's a complete <a href="http://www.lively-kernel.org/repository/webwerkstatt/documentation/overview.xhtml">overview</a>) - please <a href="http://lively-kernel.org/trac/newticket">open a documentation request</a>! At least that helps to set priorities and displays the need for documentation on specific topics.</div><div><br></div><div>Best,</div><div>Lauritz</div><br><div><div>On Nov 8, 2011, at 6:55 PM, Fabian Bornhofen wrote:</div><br class="Apple-interchange-newline"><blockquote type="cite"><div>Hi -<br><br>lately, Lauritz and I have put quite a lot of work in stabilizing Lively 2.<br>Obviously, we were not the only ones to think that Lively could use<br>more documentation, but we were not sure how to do it.<br>We now decided to try a live approach: Grow and maintain documentation<br>on the fly and in Lively itself. For us this means that whenever we<br>fix a bug (or add a feature) that requires us to do a significant<br>amount of research, we want to explain both general concepts and<br>implementation details of it in a Lively page.<br><br>In the first step, we added new folder hierarchy that should<br>(eventually) reflect Lively's subsystems.<br><a href="http://lively-kernel.org/repository/webwerkstatt/documentation/livedoc/">http://lively-kernel.org/repository/webwerkstatt/documentation/livedoc/</a><br>(we start with three pages in there, please don't expect too much :) )<br><br>Consequences will be:<br>- Developers can learn about concepts and design decisions without<br>searching for code snippets and interpreting them.<br>- Livedoc pages can contain not only descriptions of problems of<br>solutions but also live examples.<br>- Documentation will be far from comprehensive at the beginning (now).<br>- It has to be kept up to date.<br>- We can neither tag Livedoc pages nor easily cross-reference them<br>unless we put them into a database (let's do that!)<br>- The ideal result would be a handbook of Lively's design and implementation<br>- We still need to put some thinking into entry-level documentation<br>and tutorials for our tools.<br><br>What do you think?<br><br>Best,<br>Fabian<br>_______________________________________________<br>lively-kernel mailing list<br>lively-kernel@hpi.uni-potsdam.de<br>http://lists.hpi.uni-potsdam.de/listinfo/lively-kernel<br></div></blockquote></div><br></body></html>