Re: [boost] [GSoC] [Boost.Hana] Formal review request

Subject: Re: [boost] [GSoC] [Boost.Hana] Formal review request
From: Edward Diener (eldiener_at_[hidden])
Date: 2014-07-28 16:11:39

On 7/28/2014 3:17 PM, Louis Dionne wrote:
> Eric Niebler <eniebler <at> boost.org> writes:
>
>>
>> On 07/28/2014 10:20 AM, Louis Dionne wrote:
>>> So unless someone thinks the library isn't ready or would get rejected right
>>> away in its current state for reason X, I am requesting a formal review for
>>> Boost.Hana.
>>>
>>> Regards,
>>> Louis
>>>
>>> [1]: http://github.com/ldionne/hana
>>
>> I see reference docs as generated by Doxygen, but I don't see user docs.
>> Am I missing it? That would certainly be a show-stopper.
>
> As Glen points out, the tutorial is also written with Doxygen. You have to
> click on "Boost.Hana Manual" in the side bar at the left.

I do not see this side bar on the left of your GitHub page.

> It should also be
> the landing page when you enter the documentation at:
>
>      http://ldionne.github.io/hana/

I see this online. But in your instructions on your GitHub page you say 
there is an offline version in the doc/gh-pages of your library but the 
index.html there only shows the doxygen documentation.

>
> The tutorial goes through the basic concepts used everywhere in the library
> and then explains how to use the reference documentation (accessible by
> clicking "Reference" on the left panel). Perhaps you have already seen that
> but it did not qualify as a tutorial to you? That would be valid criticism.
>
> The documentation was built with Boost.Fusion as a model, i.e. a short primer
> and then a thorough reference with examples of how to use each component.
> I thought this was the best way to go given the nature of the library (a lot
> of general purpose utilities and very little room for surprise).
>
> Please let me know if you think the documentation is not adequate (or
> anything else for that matter).
>
> Regards,
> Louis