[Swift-devel] documentation formatting

[Ketan Maheshwari]

This looks great!

May be we want to utilize some space on the side so that wider  tables/code
can be nicely accommodated. A footer strip (with links, license info etc.)
similar to the header one might also look nice.

--
Ketan

On Sun, Mar 29, 2015 at 8:51 PM, Tim Armstrong <tim.g.armstrong at gmail.com>
wrote:

> Two thumbs up.
>
> I think I prefer the left as it is without any collapsing/expanding - I
> personally find expanding/collapsing outlines are overly fiddly - you have
> to click multiple times to get to a section.
>
> One problem I see is that it doesn't scale down to below a certain screen
> width - it might not work well on devices with smaller screens.  The code
> examples impose a minimum width to some extend, but it would be good if it
> scaled a little smaller.  Anyway, a minor concern - it's a big improvement.
>
> - Tim
>
> On 29 March 2015 at 20:15, Michael Wilde <wilde at mcs.anl.gov> wrote:
>
>> Nice!  I like it. :)
>>
>> Is it generated from the AsciiDoc source in an automated (or automatable)
>> manner?
>>
>> A few thoughts:
>>
>> - would be great if the left column menu was a collapsable/expandable
>> outline (eventually)
>>
>> - would be better if the right side was in the current single-doc format,
>> at least while its of manageable size.  Makes it easier to search.
>>
>> - scroll behavior is a bit odd: when the left menu hits the top or
>> bottom, the right-column text start scrolling. That might be desirable, not
>> sure.  But it felt a tad strange.
>>
>> Regardless, I think this is great and a nice improvement in readability.
>> Thanks for suggesting it and doing it.
>>
>> We should discuss whats needed to make this the new live format - or at
>> least an optional link users can select on the doc page (e.g., "New indexed
>> User Guide")
>>
>> - Mike
>>
>>
>> On Sun, Mar 29, 2015 at 8:01 PM, Hategan-Marandiuc, Philip M. <
>> hategan at mcs.anl.gov> wrote:
>>
>>> Hi,
>>>
>>> I played a bit with the format of our docs. You can see the results at
>>> http://www.mcs.anl.gov/~hategan/userguide/userguide.html
>>>
>>> I've tested it on Firefox and Chrome. It might not work as well on other
>>> browser, but the point is to get feedback on the general idea.
>>>
>>> Mihael
>>>
>>> _______________________________________________
>>> Swift-devel mailing list
>>> Swift-devel at ci.uchicago.edu
>>> https://lists.ci.uchicago.edu/cgi-bin/mailman/listinfo/swift-devel
>>>
>>
>>
>> _______________________________________________
>> Swift-devel mailing list
>> Swift-devel at ci.uchicago.edu
>> https://lists.ci.uchicago.edu/cgi-bin/mailman/listinfo/swift-devel
>>
>>
>
> _______________________________________________
> Swift-devel mailing list
> Swift-devel at ci.uchicago.edu
> https://lists.ci.uchicago.edu/cgi-bin/mailman/listinfo/swift-devel
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/swift-devel/attachments/20150329/8d34e162/attachment.html>