The Guide - again

[Ryan Schmidt]

On Mar 7, 2009, at 02:32, Martin Krischik wrote:

> I know it has been discussed before but let me bring up the Guide  
> again.
> There are few things which bug be:
>
> 1) One Guide for users and maintainer
> 2) Maintainer guide not all that complete.
> 3) The Guide not being updated all that often.
>
> Ok, 2 and three 3 imply each other. My suggestion - which is not that
> new either - is to move the maintainer guide into the Wiki.
>
> My hope is that the maintainer is updated and improved quicker and
> become more useful.


I agree it can be confusing that there is one guide that is trying to  
be useful to different classes of people (users vs. port maintainers  
vs. base developers).

I do not believe that we need to separate these into different  
documents because there is overlap between these different peoples'  
needs. We could do a better job of indicating which sections are for  
which audience, or rearranging sections in the guide to group things  
by audience.

I do not believe we need to move all or part of the guide to the  
wiki. Quite the opposite: documentation that's getting created in the  
wiki should get moved to the guide.

If there are specific things missing from the guide, please file  
tickets requesting that documentation. Please file tickets for any  
issues you have with the guide content, in fact, including  
suggestions for rearranging or whatever.