documentation [was: Help with bogofilter setup]

[David Relson]

At 07:53 PM 12/31/02, Doug Mandell wrote:

> >Doug,
> >
> >Have you any thoughts on what we could/should have done to make the
> >documentation easier to find?
> >
> >There is also info in bogofilter-faq.html and bogofilter.cf.example has a
> >lot of comments.
> >
> >David
>
>What I would do is put a README in the root directory that basically tells 
>people to look in the doc directory and check the man page for 
>documentation.  Then stick all of your documentation in doc, including the 
>example cf file and anything else that is currently scattered on 
>install.  If you could do a plaintext version of the FAQ it'd probably be 
>easier to read too (though I've seen it on the website).
>
>It's just a lot easier to find documentation if it's all in one location, 
>though I did totally miss README.Robinson (I thought it just pertained to 
>the Robinson model, not the Robinson-Fisher model), and it was staring me 
>right in the face.

Sounds like a few lines should be added to the existing README and the 
various README.xyz and example files should be moved to doc.

I'm copying this to the bogofilter mailing list to see what other folks 
think about the documentation, how it _is_ organized and how it _should_be_ 
organized.

David