[MERGE] [1.0] Move material out of User Guide into User Reference

Alexander Belchenko bialix at ukr.net
Tue Dec 11 13:16:44 GMT 2007


Aaron Bentley пишет:
> Ian Clatworthy wrote:
>> The files are now in bzrlib/help_topics/en. I think that makes them
>> discoverable enough. (All help topics are either in
>> bzrlib/help_topics.py or bzrlib/help_topics/ - basically right next to
>> each other.)
> 
> I don't think that's discoverable at all.  If we have a doc directory,
> people will look there for documentation.  If they can't find what
> they're looking for there, many will assume that the documentation they
> are looking for does not exist.

I disagree.

We build htmls from various form of docs. And they build well.
And we create bzr_man automatically from text chunks that now live
in bzrlib/help_topics.py and in help to each command.

How this fact related to discoverability?

Let's define what's main primary documentation intended to users
and what's our internal thing. Currently all texts are our internal 
thing -- from text and python sources we generate full set of html 
documentation.

Let's define policy here and make clear distinction: what should be in 
distributive (including release tarball) and what should be in bzr.dev 
sources.



More information about the bazaar mailing list