← Back to team overview

bzr-doc team mailing list archive

Re: User Reference now online as a set of topics


2010/1/9 Ian Clatworthy <ian.clatworthy@xxxxxxxxxxxxx>:
> See http://doc.bazaar.canonical.com/bzr.dev/en/user-reference/index.html.
> BTW, each help topic is now available as user-reference/xxx-help.html
> and can be referenced inside other topics as :doc:xxx-help. When
> referenced inside Sphinx, those :doc: targets ought to resolve ok. When
> converted to 'plain text' (for display from 'bzr help foo'), then the
> doc links get mapped to ``bzr help xxx``.
> Some questions/comments for discussion:
> 1. I wonder whether "Concepts" would be better labelled "Features"?

IMO no, it should not.  "Features" sounds like we'll tell you why it's
cool, but in a reference people just want to two what it is.

> 2. Do we want/need both diverged-branches and branches-out-of-sync?

I think the thing currently under 'branches out of sync' should be
merged into diverged branches.

> 3. We should move stuff out of Configuration Settings into Environment
> Variables shouldn't we?


btw some of the environment stuff may be duplicated in the man page,
and I think there is a bug about this.

> 4. Files is light on. Any takers to improve it?
> 5. Maybe Criss-Cross needs a longer name. Criss-Cross Merges? History
> Criss-Crosses? Something else?

criss-cross merges.

> 6. If you come across links referencing user-reference/index.html#foo,
> please fix them to point to the individual topics now.

Martin <http://launchpad.net/~mbp/>