[darcs-users] Review: improve front page of http://darcs.net

[Trent W. Buck]

On Thu, Oct 30, 2008 at 09:52:41AM -0500, Eric P. Mangold wrote:
> On Wed, Oct 29, 2008 at 9:43 PM, Trent W. Buck <trentbuck at gmail.com> wrote:
> > Eric P. Mangold <teratorn at gmail.com> writes:
> >
> >> Wed Oct 29 20:40:49 CDT 2008  Eric P. Mangold <teratorn at gmail.com>
> >>   * improve front page of http://darcs.net
> >>   I was a little confused by the wording on the darcs.net front-page.
> >>   Where it says "Originally developed by David Roundy" that made me
> >>   think that Mr. Roundy might not be involved in development anymore.
> >>   The kind folks on IRC set me straight, however :)
> >>
> >>   So I improved the wording in a couple places and added a section that
> >>   says a few things about the current state of the development
> >>   community.
> >
> > Thanks for helping out!  Are you interested in volunteering more time to
> > work on darcs documentation?
> 
> I can't honestly make any time commitments, but I'll help out if and
> when I can :)
> 
> Are there any particular areas of the docs that need attention?

Right now my goal is to overhaul the user manual, in particular

  1. converting it from TeX to restructured text (reST);

  2a. checking that it up-to-date (for example, does rollback
      documentation still talk about darcs1-style rollback?)

  2b. refactoring paragraphs and sections so they are more readable.

We have already made significant progress on the first point at

  darcs get http://code.haskell.org/darcs/user-manual

Things you can do right now are

  - familiarize yourself with reST (http://docutils.sf.net/) and
    doc/manual/HACKING.txt.

  - goals 2a and 2b are highly parallelizable; you can start anywhere
    in doc/manual/*.txt.

You can also help improving other documentation, such as the front
page and the wiki.