[PATCH v2] Re: MANUAL.rst: Improve with Perf tips and SSL notes

Sebastian Spaeth Sebastian at SSpaeth.de
Sun Jul 10 21:03:38 BST 2011

On Sun, 10 Jul 2011 16:12:16 +0200, Nicolas Sebrecht <nicolas.s-dev at laposte.net> wrote:
> I first thought it should NOT be in the manual but looking more closely
> (and remembering) at our documentation base it is not bad at all. We are
> very poor for a good documentation. More precisely, we miss a better
> global approach and arrangement.
> Not that /your/ patch doesn't make sense; the whole documentation needs
> a lot of improvments. Again, it mostly applies on architecture. A
> newcomer could only be lost with our information division and
> allocation. :-/

I agree, we need to think about how to arrange our documentation. Right
now the manual is just a description of hte command line options and a
very verbose description of the various UIs.

If it's called MANUAL, I think, it can take some more explanations,
tipps and tricks, and example configurations, to make it a real
manual. The most interesting part right now is in the FAQ (as a user) or
the API docs (as a developer).

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: not available
URL: <http://alioth-lists.debian.net/pipermail/offlineimap-project/attachments/20110710/39c8753a/attachment-0001.sig>

More information about the OfflineIMAP-project mailing list