On 29-05 12:52, Andrei Pelinescu-Onciul wrote:
On May 29, 2009 at 12:30, Jan Janak
<jan(a)iptel.org> wrote:
On 29-05 09:35, Andrei Pelinescu-Onciul wrote:
On May 29, 2009 at 09:50, Juha Heinanen
<jh(a)tutpro.com> wrote:
Andrei Pelinescu-Onciul writes:
> They are documented in:
> doc/dns.txt
> doc/dst_blacklist.txt
> and in NEWS (just grep after the name).
good that docs exist somewhere. however, it would be more user friendly
if core documentation would be in the wiki.
It might be, but I prefer to have it along the code. It doesn't require
starting a browser or internet access to update it and it's easy to spot
if a new feature is not documented.
How about adopting the dokuwiki syntax for plain-text documentation files in
the repository? It is readable and easy to remember and we can then come up
with a way how to synchronize them with the wiki.
Is there an easy way to generate a .html or plain txt from them or to do
some syntax checking?
They are plain text, I don't think you can do syntax checking and I don't
think it is needed, because the format is very simple:
====== Heading ======
* List item one
* List item two
- Numbered list item
paragraps separated by spaces
Links with description [[
http://usenix.org|USENIX]]
**bold** //italic// __underlined__ ''monospace''
That's all you need, I think.
If we people stick to this format in text files in the git repository then we
can easily make them visible in the wiki. Synchronization git->dokuwiki is
easy.
For the opposite direction (i.e. when somebody modifies the wiki page), I am
not yet sure, but I guess it should not be hard to make dokuwiki send a diff
to the mailing list when somebody modifies a wiki page that originates from
the git repository.
Jan.