From: Sascha Hauer <s.hauer@pengutronix.de>
To: Holger Schurig <holgerschurig@gmail.com>
Cc: barebox@lists.infradead.org
Subject: Re: barebox Documentation
Date: Tue, 13 May 2014 16:18:35 +0200 [thread overview]
Message-ID: <20140513141835.GT5858@pengutronix.de> (raw)
In-Reply-To: <CAOpc7mG5j_r8fOUcDeY2qcKZG=6LKTWr3fmWDadQfcJDquFtwg@mail.gmail.com>
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 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
next prev parent reply other threads:[~2014-05-13 14:18 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-05-13 13:42 Sascha Hauer
2014-05-13 13:50 ` Robert P. J. Day
2014-05-15 12:29 ` Sascha Hauer
2014-05-13 13:55 ` Jean-Christophe PLAGNIOL-VILLARD
2014-05-13 14:01 ` Holger Schurig
2014-05-13 14:18 ` Sascha Hauer [this message]
2014-05-13 14:32 ` Holger Schurig
2014-05-13 17:45 ` Baruch Siach
2014-05-13 15:44 ` Antony Pavlov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20140513141835.GT5858@pengutronix.de \
--to=s.hauer@pengutronix.de \
--cc=barebox@lists.infradead.org \
--cc=holgerschurig@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox