[FFmpeg-devel] [PATCH] doc: add libavcodec.texi first version
Burek Pekaric
burek021 at gmail.com
Fri Nov 2 17:00:10 CET 2012
>> The texi view is suited for developers and the wiki view is suited
>> for the users.
>
> In what aspect is the "wiki view" different from the HTML generated from
> the
> texi source files that makes it better suited for users?
Auto generated wiki defies the purpose of the wiki itself. Have you ever
used a wiki system so far?
The wiki system is designed for user contributions (for example Wikipedia is
a wiki system, too). It is provided as a convenient way for people to
contribute to a project (in our case the documentation), adding/updating
articles and building a knowledge base for future reference. That makes it
easy for a project to build the documentation quicker, since a lot of people
can contribute to it, without even knowing much about coding (or texi, git,
patches, mailing lists, etc.). They are presented with the nice and
intuitive web user interface so they can easily get to the work, without a
lot of preparation. Shortly, it is desinged to speed up the documentation
building.
If you make it an auto-generated thing, then you will have to decide who has
the edit access to the original stuff, which the generated stuff is based
on. Also, you have to deal with the merging of auto-generated stuff and
user-contributed material, which makes it difficult (but not impossible) to
implement and maintain.
More information about the ffmpeg-devel
mailing list