barebox Documentation

[Sascha Hauer]

On Tue, May 13, 2014 at 04:01:07PM +0200, Holger Schurig wrote:
> If wiki and doxygen are not updated, than this is a sign that they
> should probably be outphased.
> 
> Instead, I'd prefer to have text files in the Documentation/ tree. So
> changes to them pass the normal review process.

+1

> 
> > Plain text files
> > - no links
> > - no pictures
> 
> If we use some special format for them, e.g. Markdown or *.rst, then
> the files can still converted to HTML, and links and images could
> still be possible. That would mean that wiki.barebox.org probably goes
> away, but that (part) of www.barebox.org is generated from the
> *.rst/Markdown files.

This sounds like the best of two worlds. Do you know an example of a
project with markdown/rst documentation?

Sascha

-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |