January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Attachments: | On Tue, 6 Jan 2015 22:32:05 -0800
"H. S. Teoh via Digitalmars-d" <digitalmars-d@puremagic.com> wrote:
> On Wed, Jan 07, 2015 at 07:44:39AM +0200, ketmar via Digitalmars-d wrote:
> > On Tue, 06 Jan 2015 14:43:45 -0800
> > Andrei Alexandrescu via Digitalmars-d <digitalmars-d@puremagic.com>
> > wrote:
> >
> > > Let's crowdsource the review. Please check the entries linked from here: http://dlang.org/library/index.html.
> > so looking at the function documentation i lost that nice indexes. if i got to the function directly (which will be very likely with googling), now i have to either drop keyboard and use mouse to click on module name (which is not immideately pops like a link, btw), possibly scrolling the page to top, or try to use keyboard navigation, which has only one thing in common for various browsers: it's awful.
> [...]
>
> You should use Vimperator. :-P I started using it recently, didn't like it that much at first, but I'm starting to like it more and more. Thanks to the hinting system, my rodent is even more out-of-use nowadays, which I consider a Good Thing(tm).
sadly, there is no such thing for Opera 12. T_T
|
January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Tuesday, 6 January 2015 at 22:43:45 UTC, Andrei Alexandrescu wrote: > Let's crowdsource the review. Please check the entries linked from here: http://dlang.org/library/index.html. > > Andrei Has it been generated from an up-to-date version? Where are the sub modules of std.container? http://dlang.org/library/std/container.html |
January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Tobias Pankrath | On 1/7/15 12:22 AM, Tobias Pankrath wrote: > On Tuesday, 6 January 2015 at 22:43:45 UTC, Andrei Alexandrescu wrote: >> Let's crowdsource the review. Please check the entries linked from >> here: http://dlang.org/library/index.html. >> >> Andrei > > Has it been generated from an up-to-date version? Where are the sub > modules of std.container? > > http://dlang.org/library/std/container.html Try http://dlang.org/library-prerelease/std/container.html -- Andrei |
January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On 1/7/15 12:24 AM, Andrei Alexandrescu wrote: > On 1/7/15 12:22 AM, Tobias Pankrath wrote: >> On Tuesday, 6 January 2015 at 22:43:45 UTC, Andrei Alexandrescu wrote: >>> Let's crowdsource the review. Please check the entries linked from >>> here: http://dlang.org/library/index.html. >>> >>> Andrei >> >> Has it been generated from an up-to-date version? Where are the sub >> modules of std.container? >> >> http://dlang.org/library/std/container.html > > Try http://dlang.org/library-prerelease/std/container.html -- Andrei Apparently the links exist, but don't work, e.g. http://dlang.org/library-prerelease/std/std_container_array is not to be found. -- Andrei |
January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Walter Bright | On Wednesday, 7 January 2015 at 07:12:33 UTC, Walter Bright wrote:
> On 1/6/2015 10:48 PM, Andrei Alexandrescu wrote:
>>> Another one; I tried to use the search box on the top right corner...
>>> it just resulted in a google search.
>>> Can we do better than that? When people go to the documentation page,
>>> they want to search the docs, not get a standard google results page.
>> That would be quite an involved project. -- Andrei
>
> I find dman.exe to be very handy and use it all the time, but since it is a hand-built index, it is always hopelessly out of date.
Why not reuse the index built by chmgen? It's very inclusive and mostly accurate.
|
January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On 1/6/15 2:43 PM, Andrei Alexandrescu wrote:
> Let's crowdsource the review. Please check the entries linked from here:
> http://dlang.org/library/index.html.
Many thanks to those who provided feedback on the new layout!
I've fixed a few issues, but it looks like there are quite a few more problems than I had anticipated. I encourage any and all of you to build the documentation locally (make -j should work nicely) and help with pull requests to github. Let's get this off the ground together.
Thanks,
Andrei
|
January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu |
> Apparently the links exist, but don't work, e.g. http://dlang.org/library-prerelease/std/std_container_array is not to be found. -- Andrei
It works from the tree on the left.
|
January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Tuesday, 6 January 2015 at 22:43:45 UTC, Andrei Alexandrescu wrote: > Let's crowdsource the review. Please check the entries linked from here: http://dlang.org/library/index.html. From my last complain thread: http://forum.dlang.org/post/zazgfoxjwhjbdrgdiiqv@forum.dlang.org I see that many of the issues with my example got fixed. Remaining issues: * Overzealous linking of words in the documentation that happen to coincide with symbols in the same module. This should only be done for text in $(D ...) tags. * Compile-time expressions are expanded to their computed variant. For example, `size_t.max` is expanded to `18446744073709551615LU`, which is not informative, and wrong on 32-bit systems. `Config.none` is now `cast(Config)0`, which sucks. I guess this is a compiler issue rather than a DDox one. More issues I noticed now from a quick look: * http://dlang.org/library/std/process.html : The comparison table is gone, replaced with an unstructured blob of text. * http://dlang.org/library/std/parallelism.html : More overzealous linking (e.g.: "These include _parallel_ foreach, _parallel_ reduce, _parallel_ eager map, ..."). * http://dlang.org/library/core/time.html : More overzealous linking - symbols within D string literals should not be linked. * I still have reservations about using Disqus. |
January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Posted in reply to weaselcat | On 2015-01-07 00:44, weaselcat wrote: > Is it intentional for all of the stdc pages to be empty? Why is even std.c.* still available. These should all be replaced with core.stdc.*. -- /Jacob Carlborg |
January 07, 2015 Re: Ready to make page-per-item ddocs the default? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On 2015-01-06 23:43, Andrei Alexandrescu wrote: > Let's crowdsource the review. Please check the entries linked from here: > http://dlang.org/library/index.html. What about all those suggestions in the thread "Improving ddoc" [1]? Some of those suggestions might require to redesign the documentation. Is it still worth updating to the new layout? [1] http://forum.dlang.org/thread/m81k2p$k47$1@digitalmars.com -- /Jacob Carlborg |
Copyright © 1999-2021 by the D Language Foundation