Ticket #7 (defect)

Opened 5 years ago

Last modified 5 years ago

Make documentation!

Status: assigned

Reported by: krys Assigned to: krys (accepted)
Priority: major Milestone: Release 0.3
Component: TurboLucene Version:
Keywords: Cc:

Make documentation!

There should be a "getting started guide" (quick start?), tutorial (from a new project), API documentation (epydoc), and maybe reference documentation too.

A screencast would also be nice.

Change History

02/03/07 22:56:35: Modified by krys

  • priority changed from critical to blocker.
  • status changed from new to assigned.

03/05/07 22:46:27: Modified by krys

A tutorial was added at WikiTutorial. API documentation is comming. A quick start/getting started page would also be nice.

03/09/07 05:25:43: Modified by krys

  • priority changed from blocker to major.
  • version changed from 0.1.1 to 0.1.2.

API docs are now available. Epydoc is nice! :-)

03/11/07 05:25:06: Modified by krys

I have added a link to Lucene's query syntax page.

03/11/07 05:27:20: Modified by krys

There should also be documentation about catching TurboLucene's logging.

04/01/07 23:16:07: Modified by krys

  • version changed from 0.1.2 to 0.2.
  • milestone set to Release 0.3.

I want to finish this ticket off before release 0.3 is released.

05/23/07 02:57:04: Modified by krys

  • version deleted.