[Bf-docboard] Proposal for restructuring the user manual

[Campbell Barton]

Eh, sorry for the noise... had some duplicate dir's around (from
testing remapping), make that 1696 :doc: roles & 48 index.rst's.

On Mon, Dec 29, 2014 at 9:22 PM, Campbell Barton <ideasman42 at gmail.com> wrote:
> Committed RST remapping tools,
> https://developer.blender.org/rBM0c19dba6fcc12a7fa1645d67e5b4bd048fc8fbcb
>
> Workflow:
>
> # execute:
> ./tools/rst_remap.py start
>
> # re-arrange file-structure
>
> # execute
> ./tools/rst_remap.py finish
>
> ... after index.rst files will likely need manual editing. but this
> saves updating 100's of :doc: references (almost 2000 in fact), by
> comparison we only have 52 index.rst's.
>
> On Mon, Dec 29, 2014 at 9:37 AM, Campbell Barton <ideasman42 at gmail.com> wrote:
>> On Mon, Dec 29, 2014 at 12:16 AM, Gaia <gaia.clary at machinimatrix.org> wrote:
>>> Hi;
>>> That was a lot of feedback so far :)
>>> Below is a revised version of a Blender Manual structure
>>> based on all comments and further ideas:
>>>
>>> Getting Started
>>>
>>> Introduction
>>> Installation
>>> Basic usage
>>>
>>> Interface
>>> 3D Interaction (not sure what to do with that)
>>> Setting the Default Scene
>>> Help System
>>> Render Engines (brief)
>>> Quick steps (to be defined)
>>>
>>> User Preferences
>>> The Data System
>>> Game Engine
>>> Extending Blender
>>> Troubleshooting
>>>
>>> Render Engines
>>>
>>> Blender Internal
>>> Cycles
>>> Freestyle
>>>
>>> Import/Export
>>>
>>> FBX
>>> Collada
>>> Wavefront
>>> ...
>>>
>>> Topics
>>>
>>> Modeling
>>> Materials
>>> Textures
>>> World
>>> Physics
>>> Modifiers (not sure if this is a topic or a reference article)
>>> Animation
>>>
>>> Rigging
>>>
>>> 2D
>>>
>>> Rendering
>>> Compositing
>>> Motion Tracking (maybe this is NOT 2D)
>>> Grease Pencil
>>>
>>> Constraints (not sure if this is a topic or a reference article)
>>>
>>> Reference (could be added later?)
>>>
>>> 3D View
>>> Timeline
>>> Graph Editor
>>> Dope Sheet
>>> NLA Editor
>>> UV Image Editor
>>> Video Sequence Editor
>>> Movie Clip Editor
>>> Text Editor
>>> Node Editor
>>> Logic Editor
>>> Properties Editor
>>> Outliner
>>> User Preferences (link to User Pref in the Getting Started Section?)
>>> Info Window
>>>
>>> Glossary
>>>
>>> -gaia-
>>
>> Some brief comments,
>>
>> - Is "Topics" intended to be a Page on its own? Titles like
>> "Animation" seem like they should be top level links.
>>
>> - having '2D' as a section seems a bit arbitrary... are UV's 2D?
>> Grease pencil can be 3D too..., think its an unnecessary category.
>>
>> - Space-Type Reference,.. can be nice, but would be wary of people
>> adding too much content there,
>>  they should be a quick reference of the space-type, but as details
>> about workflows should go in the manual.
>
>
>
> --
> - Campbell



-- 
- Campbell