[Bug 756643] New: The order in which to read the documentation is not clear

[GStreamer (GNOME Bugzilla)]

https://bugzilla.gnome.org/show_bug.cgi?id=756643

            Bug ID: 756643
           Summary: The order in which to read the documentation is not
                    clear
    Classification: Platform
           Product: GStreamer
           Version: git master
                OS: Linux
            Status: NEW
          Severity: normal
          Priority: Normal
         Component: documentation
          Assignee: gstreamer-bugs at lists.freedesktop.org
          Reporter: exebook at gmail.com
        QA Contact: gstreamer-bugs at lists.freedesktop.org
     GNOME version: ---

This page: http://gstreamer.freedesktop.org/documentation/

reads in the first row:

Application Development Manual (Read this first)

"Read this first" assumes it is a starting point for someone willing to learn
GStreamer.

And although parts 1 and 2 of the aforementioned Development Manual could
really be read and understood by a newcomer, part 3, which is titled Advanced
Concepts is way too hard for a "read this first" document.

So my suggestion is either move Part 3 to a separate manual, or have a
statement(s) in it saying "If you are learning, and reading this as your entry
point into the GStreamer, skip this, this and this page/chapter."

In fact, Chapter 19 even says "be assured that you'll need ...good
understanding of GStreamer before you start reading this". Which contradicts
the "Read this first" clause in the beginning. You either "read this first" or
"have a good knowledge of GStreamer", right? 

I understand the intention was to add more and more detail to the manual, but
it becomes too hard to read for an unprepared, and you do not know which parts
can be skipped when you read it as your entry point into GStreamer world. And
when you are unprepared where do you start?

-- 
You are receiving this mail because:
You are the QA Contact for the bug.
You are the assignee for the bug.