Ticket #1 (closed enhancement: fixed)

Opened 2 years ago

Last modified 2 years ago

Documentation needed

Reported by: Jonathan Métillon <jmetillon@gmail.com> Assigned to: jcm
Priority: blocker Milestone: 0.1 with tests
Component: doc Version: 0.1
Keywords: Cc:

Description

Better Nested Set needs documentation:

* How to install (svn checkout?) * How to use (avaiable methods: why not point to a generated rdoc?)

Change History

08/07/06 16:45:48 changed by jcm

  • status changed from new to assigned.

Some doc updated in the code comments. I added the Rake file to produce doc, and placed api here too:

http://opensource.symetrie.com/api/better_nested_set/

There's now an example page too on the wiki.

Add here suggestions to improve doc.

10/10/06 11:39:36 changed by jcm

  • milestone deleted.

Milestone milestone3 deleted

10/10/06 13:25:20 changed by jcm

  • keywords deleted.
  • cc deleted.
  • version changed from 1.0 to 0.1.
  • component changed from component2 to doc.
  • milestone set to 0.1 with tests.

12/12/06 03:36:35 changed by Krishna

  • status changed from assigned to closed.
  • resolution set to fixed.

I have gone through all of the documentation, attempting to clean it up and standardize it. The README has installation instructions and examples, and the generated RDoc looks good.

Should we include the docs in svn so users don't have to generate them?