Project documentation on Launchpad

[Colin D Bennett]

On Wed, 11 Mar 2009 14:56:44 +0100
Jelmer Vernooij <jelmer at vernstok.nl> wrote:

> On Tue, Mar 10, 2009 at 07:05:33PM +1100, Ben Finney wrote:
> > (Is there a place at Launchpad
> > where the documentation for a package is stored? Or does Launchpad not
> > encourage standard documentation for packages?)
> Not sure I follow, if there would be more documentation necessary 
> it wouldn't be on Launchpad but inside of the package itself. Similar
> to e.g. alioth.

There are many times when I wish there was documentation for projects
on Launchpad:  Often I find a new project on Launchpad and want to
quickly read about it to learn what it does or how to use it before I
take the time to download the code or install it.  The one-paragraph
(if you're lucky!) descriptions on the project pages are usually not
nearly enough to decide it a project will do what you need.

There definitely should be a 'Documentation' tab on Launchpad projects
with at least a FAQ, or an introduction to the project.

Most of the Bazaar tools on Launchpad have a 'homepage' or wiki link on
their Launchpad page; this is good.  However, many projects have NO
INFORMATION on the Launchpad project page.  

No documentation:

https://launchpad.net/bzr.webdav

https://launchpad.net/bzr-update-mirrors

https://launchpad.net/bzr-stats
  Could they at least list what statistics it provides?


Documentation on Launchpad, in various ways:

https://launchpad.net/bzr-power-management
  This simple plugin thankfully provides usage information on the
  project description page.

https://launchpad.net/bzr-loom
  The Loom plugin has a link to the HOWTO in the trunk branch.


Anyway, my point is that it is critical to me that I can access
introductory documentation before I download a program.

Regards,
Colin