Documentation reorganisation

Martin Pool mbp at sourcefrog.net
Fri Jul 27 17:49:47 BST 2007


That page looks good.  I plan to work on some documentation when I get
home next week.

On that page:

I think we should directly link to the quick reference card, rather than
having the stubby page http://bazaar-vcs.org/BzrQuickReference

I guess the user guide will be put into a Bazaar branch and generated from
ReST?  We could still have direct links into various interesting bits of
it.

Maybe 'Giving Back' should change into a link to the core developer guide?
I wonder whether that should be just a chapter in the overall
developer guide.  I can see how you'd have some material that's
interesting only to people writing plugins vs contributing to Bazaar
itself, but there's also a lot of overlap.

Wow, the glossary is quite good now.  That maybe also should go into the
user guide, but perhaps should be also linked from this page.
http://bazaar-vcs.org/BzrGlossary

I think much of the General Information section should be moved to be
accessible through the web site menus, rather than as documentation.
'Community' in particular might be better under 'Community' on the wiki.

Maybe '3rd Party Tools' and 'BzrEnhances' should be combined with plugins?
Even if they're not technically plugins, from the user's point of view
they are things that go together with Bazaar.

It looks like http://bazaar-vcs.org/BazaarBook also needs to be folded
into the documentation.  That's pretty interesting, I wasn't aware it was
there.

I think Screenshots also deserve to be in a web site menu.

The advocacy pages probably need to be combined.  That information should
begin on the front page and continue over the fold...

Quotes is also community.

-- 
Martin



More information about the bazaar mailing list