Re: [boost] boost @ github (was: Re: [Review] Boost.Endian mini-review)

Subject: Re: [boost] boost @ github (was: Re: [Review] Boost.Endian mini-review)
From: Beman Dawes (bdawes_at_[hidden])
Date: 2015-01-27 13:39:22

On Tue, Jan 27, 2015 at 11:46 AM, Stefan Seefeld <stefan_at_[hidden]> wrote:
> Hi there,
>
> sorry to hijack this discussion, but trying to view at the docs I had
> some generic questions:
>
> On 23/01/15 11:17 AM, Joel FALCOU wrote:
>> The docs for the library can be viewed online at
>> https://boostorg.github.io/endian/
>
> Are there plans to make all of the boost docs  / website available
> through https://boostorg.github.io ?

Not that I know of. It is convenient to have a library's docs online
for mini-reviews, and I used GitHub to do that because it is so
convenient.

> At present https://boostorg.github.io/endian/ appears to work mostly
> fine, though the logo is missing, and the toplevel link to
> https://boostorg.github.io/index.html yields a 404 error. Is that
> supposed o work?

No, since those are both links to the super project, and for purposes
of a mini-review they were not necessary.

> Are library authors required to do anything to
> generate those docs, and is that documented anywhere ?

No, and no. I sometimes publish master docs and sometimes develop
docs, according to current needs.

>
> (I'm looking at https://svn.boost.org/trac/boost/wiki/ModularBoost but
> find that to be lacking a bit behind, so it's hard to figure out what
> actually works and what is only planned. )

If we do ever require it, those pages will get updated.

Cheers,

--Beman