[Swift-devel] documentation formatting

Michael Wilde wilde at mcs.anl.gov
Sun Mar 29 20:15:47 CDT 2015


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
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/swift-devel/attachments/20150329/3b330b24/attachment.html>


More information about the Swift-devel mailing list