[Bug 773976] split docs into sub-folders

[GStreamer (GNOME Bugzilla)]

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

Sebastian Dröge (slomo) <slomo at coaxion.net> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |slomo at coaxion.net

--- Comment #14 from Sebastian Dröge (slomo) <slomo at coaxion.net> ---
(In reply to Tim-Philipp Müller from comment #13)
> 
> I'm wondering whether we should use this opportunity to rename the "manual"
> subdirectory to something more descriptive, like "application-development"
> or such.

Yes, "manual" was often confusing for people, it's too generic.

> I think the manual/building/ subdirectory is confusingly named (this is
> based on the existing filenames of course), maybe it should be "basic"
> instead?
> 
> Or maybe we should not do subdirectories for the manual at all?

Seems ok either way to me, "basic" also makes sense.

> >	pwg/
> >		pwg/introduction/
> >			...
> >		pwg/building/
> >			...
> >		pwg/advanced/
> >			...
> >		pwg/other/
> >			...
> >		pwg/appendix/
> >			...
> 
> Similar questions as for the manual really.
> 
>  - should we rename "pwg" to something more expressive?
>    "plugin-writing" or "plugin-development" or such?

"plugin-development" (and "application-development")

>  - pwg/building/ seems confusingly named (based on old filenames)
> 
>  - pwg/other/ is not very well named, looks like it's more for specific use
> cases.

"basic" and "higher-level-base-classes"?

> Sebastian wanted for images to be placed alongside the markdown docs where
> they're used IIRC. This can always be changed later though, doesn't affect
> public site structure.

Yes please, but can be done later. It's just messy otherwise :)

> Not entirely sure about the markdown/ subdirectory (existence plus name),
> but can live with it and it doesn't affect the public site structure. Can't
> think of a better name right now either.

Why does it have to exist?

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