Re: [matplotlib-devel] matplotlib user guide

[mark <ma...@me...>]

hi matplotlib developers

as I previously posted, I have thought about structure and flow of the
user guide

my fist cut of a change set is viewable here:
https://github.com/marqh/matplotlib/compare/userGuideShape

it keeps all of the same content as the current user guide but
subdivides some sections into categories:
   configuration
   beginner's guide
   advanced guide

So, all feedback very gratefully received, but a particular focus
requested on:
  - sub-section headings
  - sub-section contents (scope)
  - ordering

I would like to focus on getting the categorisation and ordering
helpful for this piece of work.

I feel that this will give us more accessible ways into adding new
sections or adapting sections but that this should wait for a follow up
activity.

many thanks
mark

On Wed, 25 Sep 2013 08:19:59 +0000
mark <ma...@me...> wrote:

> hi matplotlib developers
> 
> I have been considering the matplotlib user guide structure and it
> has occured to me that there are two user guides interleaved here:
>   1. Introduction for new users
>   2. Library tour for developers
> 
> I think that this structure makes it challenging for new users to
> benefit from the user guide as much as they could.  
> 
> I would like to see the user guide separated into two sections, with
> the two different audiences in mind.  I feel this would enable new
> users of the library to have a more targeted introduction to some of
> the neat features without getting bogged down in details they are
> unlikely to need (or comprehend). 
> 
> I am very happy to have a go at this and put up a set of suggested
> changes but I would value input from the community on this approach
> and my category suggestions before I submit a pull request.
> 
> many thanks
> mark
> 
> 
> ------------------------------------------------------------------------------
> October Webinars: Code for Performance
> Free Intel webinars can help you accelerate application performance.
> Explore tips for MPI, OpenMP, advanced profiling, and more. Get the
> most from the latest Intel processors and coprocessors. See abstracts
> and register >
> http://pubads.g.doubleclick.net/gampad/clk?id=60133471&iu=/4140/ostg.clktrk
> _______________________________________________ Matplotlib-devel
> mailing list Mat...@li...
> https://lists.sourceforge.net/lists/listinfo/matplotlib-devel