Better docs for D (WIP)

Rory McGuire via Digitalmars-d-announce digitalmars-d-announce at puremagic.com
Sun Jan 31 03:14:08 PST 2016


On Sat, Jan 30, 2016 at 10:58 PM, Adam D. Ruppe via Digitalmars-d-announce <
digitalmars-d-announce at puremagic.com> wrote:

> Just want to update y'all that my better docs continue to improve with
> each passing week.
>
> I just did a style facelift on the members section:
>
> http://dpldocs.info/experimental-docs/std.algorithm.setops.html
>
> (and yes, that's mostly css style! I did a minor change to the html, you
> can see the old here: http://dpldocs.info/experimental-docs/std.stdio.html
> (well, at least until I rebuild the docs of all of Phobos again), but the
> css is the big thing. It is nice having semantic markup.)
>
>
> So I hope that is more readable. The sidebar is also new over the last
> couple weeks, giving a sorted list of sibling names - including package
> listings.
>
> If you go into a thing:
> http://dpldocs.info/experimental-docs/std.stdio.write.html you can see
> how the sidebar shows the immediate siblings only, which makes the list a
> lot more managable than trying to cram everything everywhere. I find the
> Phobos official sidebar to be useless because there's just too much there.
>
> BTW the recent push that makes constraints small and grey, check this out
> for example:
>
> http://dlang.org/phobos/std_algorithm_sorting.html#completeSort
>
> I feel is no help. The readability is still poor and it doesn't help with
> navigation. In my new members thing, I used a small, hoverable prototype...
> but just on the index. Once you click through, I still have the full
> details, formatted for legibility.
>
> This reform is not appeasing my revolution....
>
>
>
> Anyway, I feel that this is really starting to come together now... pretty
> soon, I'll promote it to "alpha" from its current state of "pre-alpha".
> Just gotta write the new search engine first!
>


If you don't get a cease and desist letter from the D Foundation soon I'd
be surprised. Your matter of fact insulting of our official docs (which are
leaps and bounds better than the new stuff you are making) is destructive
to our community.

Having a different kind of search and having a different layout that is
more succinct is "Super Awesome" and you are doing it, but you have
absolutely no reason to constantly insult the work on the main site.

_Creating division in such a small community is not helpful_. Having
competing designs can be very helpful, (e.g. your layout could be nice for
Google search results), official docs are nice because you don't have to
constantly jump around the site while working.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.puremagic.com/pipermail/digitalmars-d-announce/attachments/20160131/e439910e/attachment-0001.html>


More information about the Digitalmars-d-announce mailing list