Documentation Layout
Jakob Ovrum
jakobovrum at gmail.com
Wed Mar 28 22:26:44 PDT 2012
On Wednesday, 28 March 2012 at 06:20:57 UTC, James Miller wrote:
> In another thread
> (http://forum.dlang.org/thread/CAMfGmZsNX3GsOFVyUaCX79E4H8eTBXqDmUJtm41JSzRNtME=RQ@mail.gmail.com)
> I raged about std.container's documentation, then Teoh pointed
> out
> that a lot of Phobos documentation needs improving. While he was
> talking about content, it got me thinking about the actual
> presentation of Phobos's documentation. Now, I have an interest
> in UX
> and I am a web developer my trade, so here's what I think it
> wrong
> with general layout+design right now and what could be done to
> fix it.
> -snip-
There is a simple project called cuteDoc (name comes from the old
candyDoc theme) which has a demo using the Phobos documentation:
http://robik.github.com/phobos/
Project home page:
https://github.com/robik/cuteDoc
It has some rudimentary JavaScript for a module list and a
generated jump-to table. I would love to see the Phobos
documentation on dlang.org do something similar; there's so much
low-hanging fruit for D's documentation that I wish someone with
some web savvy would pick up on. It's pretty baffling to think
that some Phobos modules have *manually maintained* table
headers, what the heck were people thinking? What happened to
automation?
More information about the Digitalmars-d
mailing list