On Tue, Feb 25, 2014 at 8:57 PM, Hadriel Kaplan
<hadriel.kaplan@xxxxxxxxxx> wrote:
>
> On Feb 25, 2014, at 8:44 PM, Evan Huus <eapache@xxxxxxxxx> wrote:
>
>> I'm all for consolidating the above information - we just need to
>> decide which of the many places to consolidate *to*. We've been
>> playing musical chairs every few months moving things around from A to
>> B, B to C, and C to A, but never actually getting anywhere.
>
> Personally I think the wiki makes the most sense, because none of that stuff is specific to the code version/branch/state; as opposed to the info in most of the docs/READMEs, which are specific to the release.
>
> Also we can subscribe to changes of that wiki page, and thereby get notified via email of changes instead of happening to notice a change in a txt/asciidoc file in the code tree.
>
> It's really the kind of thing a wiki's for, imo.
That makes sense to me. So more broadly, how about:
- user documentation in the user guide as asciidoc (currently in
docbook/ in git, though I guess that should be moved since it won't be
using docbook anymore)
- developer documentation on the wiki
- api documentation in doxygen
If this makes sense to everyone, then:
- the wiki needs a major structural cleanup, much of it is quite
stale; I am half-tempted to wipe everything (or namespace it to old-*
or something) and start fresh
- wireshark's doxygen output needs to be made more accessible (it's
already hosted publicly somewhere but I couldn't find a link to it)
- the developer guide and doc/README.* need to be parcelled up between
the wiki and doxygen comments, then removed
- the user's guide should be converted to asciidoc like the developers
guide, and then moved to doc/
Thoughts?
