RFC: Missing part of genode OSD :: A user wiki

Norman Feske norman.feske at ...1...
Mon Mar 5 20:22:00 CET 2012

Hello Althaf,

> It would be beneficial to keep a user specific wiki, i meant not the
> actual documentation that is provided in the Genode home, but some
> newbie guide to getting started. Say  setting up network interface ,
> how to. etc. Well, though source tree is well organised , it can be a

I think that these topics should ultimately be covered by our official
documentation. Your criticism is valid for sure. But I think the problem
is not so much the technical question of which tool to use (Wiki versus
Git repository) but rather our lacking ability to put ourselves in a
true beginner's position. The top-level 'README' and the
'doc/getting_started.txt' are our current attempt to do so - apparently
with limited success. I would be very happy about true beginners to
suggest improvements regarding these documents. I hope that thanks to
GitHub, the bar for beginners to suggest improvements is low enough. I'm
positive about it, taking our experience of the past weeks as some kind
of empirical evidence. Your contributions are a good example. .-)

With regard to providing working step-by-step instructions, I think that
the concept of our run scripts is principally well suited for this
purpose as each of those scripts illustrates the steps needed to
integrate a certain component in a setup of low complexity. Because such
scripts are executable, maintaining their consistency with the actual
system is easy. If we provided a bunch of "howto" documents instead, we
would have a hard time to ensure consistency. Inconsistent or misleading
documentation, however, would be worse than having a no documentation.


More information about the users mailing list