[Xapian-discuss] Writing a Quick Start Guide to Xapian

[Andrew Betts]

Completely agree with Justin.  But I think the last time this came up there was some disagreement over the mechanism by which the docs should be produced.  Anyway, very happy to help.

----- Original Message -----
From: "Justin Finkelstein" <justin at redwiredesign.com>
To: "Andrew Betts" <andrew.betts at assanka.net>
Cc: xapian-discuss at lists.xapian.org
Sent: Thursday, 28 July, 2011 2:36:04 PM
Subject: Re: [Xapian-discuss] Writing a Quick Start Guide to Xapian

I think what would be good is if we had a representative from each of the major programming languages that use it, so that the documentation is compiled of: 

o Core concepts: what Xapian is (and isn't); how it works; what each of the different capabilities it offers can do 
o Then a series of worked-through examples, in a each language, of how to do pretty much everything 

To me, this would produce what I believe is commonly called a 'cookbook', giving people a real head-start in adoption. 

If we could get this done, then we're well on the way to an excellent set of docs. 

In addition, my company'd still like to offer our design services for a fancy redesign of the site (for free, in return for a link/credit somewhere), if there's interest.