Boost logo

Boost :

From: Beman Dawes (bdawes_at_[hidden])
Date: 2003-07-19 09:38:42

At 03:10 PM 7/18/2003, Peter Dimov wrote:

>index.html should stay so that works. Whether
>the contents should change is another matter.

Yes, exactly.

In response to requests from Nico Josuttis and others, we committed to
every library having an index.htm (or .html) file at its top level. If the
actual docs live elsewhere it can just redirect to the correct page.

Doing this allows authors to publish books referring to Boost libraries
without being concerned that the location of the library's docs may change
within the library's sub-tree.

For the same reason, it is the preferred way for source code to refer to
documentation. For example (from <boost/any.hpp>):

// See for Documentation.

Some of the Boost tools software takes advantage of that convention to
determine what library a header file belongs to.


Boost list run by bdawes at, gregod at, cpdaniel at, john at