Topic Based Documentation
Background
Besides the API documentation, the project has two manuals: Application Development Manual (ADM) and Plugin Writer's Guide (PWG). We currently face a few issues with them:
- those are hard to keep up to date
- they are not cross references with the API docs
- they both have some basic gstreamer concept introduction
we also have the design docs
Task
We should merge the gstreamer framework introduction to the API docs. Both ADM and PWG should be rewritten as topic based documents as project mallard suggests. Both documents should link more to the API docs.
We also want a concept for how to keep the FAQ up-to-date, by monitoring the questions on the mailing list.
Resources
Mentor: Stefan Kost - ensonic on IRC
Back to TaskList