March 11, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrej Mitrovic | On 2014-03-11 16:52, Andrej Mitrovic wrote: > I think on pages where we provide a cheat-sheet like in std.algorithm > it's probably a good idea to remove the auto-generated list of > functions, because it's essentially a duplicated list (and the > cheat-sheet is better because it's humanly organized): > > http://dlang.org/library/std/algorithm.html The correct solution is making the automatically generated one as good as the manually. It shouldn't be hard to add a new Ddoc macro that is recognized and indicates which category a symbol belongs to. Something like: /// $(CATEGORY searching) void foo (); -- /Jacob Carlborg |
March 11, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Steven Schveighoffer | On Tuesday, 11 March 2014 at 15:38:21 UTC, Steven Schveighoffer wrote:
> On Tue, 11 Mar 2014 11:12:51 -0400, Andrei Alexandrescu <SeeWebsiteForEmail@erdani.org> wrote:
>
>> On 3/11/14, 6:55 AM, Ivan Kazmenko wrote:
>>>> http://dlang.org/library
>>>
>>> Looks nice!
>>>
>>> I second the opinion that Disqus might have a better alternative. Its
>>> loading after the page was rendered looks clumsy, its style does not
>>> match that of dlang.org's... the whole thing is somehow out of place.
>>
>> Unless something better comes about, we'll go with disqus. Sönke, are there styling options available?
>
> I want to stick my neck out and say that I love disqus *ducks*. But I don't know that it's what we should use in this instance. Disqus is great when you are having a live debate. New posts get loaded in real-time, votes are recorded in real-time, so it's very fluid.
>
> But in this case, I don't see any fierce debates occurring on doc pages. Probably simple notes or "useful tricks" is what will appear there. A "live update" feature is pretty much overkill for such static discussion.
>
> That being said, I've been on plenty of disqus sites, and they look different, act different, but have the same general look and feel.
>
> An idea -- would it be possible to search links from the D forum, and post underneath the discussions that link to that doc page? Then have some sort of moderation so non-doc-related discussions don't clutter the page? Maybe even just first few sentences of the post, with a link to the D forum...
>
> Then we don't have to have any kind of new interface for D posts, just a copy of what's already in discussion.
Sure, we could do that.
Together with an "Ask a question about std.modulename.symbolname" link that goes to a partially pre-filled form ready to post to d.learn.
|
March 11, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Vladimir Panteleev | On Monday, 10 March 2014 at 22:50:54 UTC, Vladimir Panteleev
wrote:
> On Monday, 10 March 2014 at 22:28:11 UTC, Nick Sabalausky wrote:
>> On 3/10/2014 11:08 AM, Andrei Alexandrescu wrote:
>>> On 3/10/14, 7:00 AM, Dicebot wrote:
>>>> I still don't like disqus :)
>>>
>>> Are there better such systems available?
>>>
>>
>> Yea, forum.dlang.org ;) And anything else that doesn't completely and totally break without JS.
>
> A possible plan for forum.dlang.org integration:
BTW, as I understand, we can export data from Disqus any time, so
there should be no pressure to decide on this right now.
|
March 11, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Jacob Carlborg | On 3/11/14, 10:38 AM, Jacob Carlborg wrote:
> On 2014-03-11 16:52, Andrej Mitrovic wrote:
>
>> I think on pages where we provide a cheat-sheet like in std.algorithm
>> it's probably a good idea to remove the auto-generated list of
>> functions, because it's essentially a duplicated list (and the
>> cheat-sheet is better because it's humanly organized):
>>
>> http://dlang.org/library/std/algorithm.html
>
> The correct solution is making the automatically generated one as good
> as the manually. It shouldn't be hard to add a new Ddoc macro that is
> recognized and indicates which category a symbol belongs to. Something
> like:
>
> /// $(CATEGORY searching)
> void foo ();
Yes to that. I seem to recall we have something similar on the homepage.
Could you please get something started to serve as a pattern to follow for all of us?
Thanks,
Andrei
|
March 11, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Vladimir Panteleev | On Tue, 11 Mar 2014 13:41:23 -0400, Vladimir Panteleev <vladimir@thecybershadow.net> wrote:
> On Tuesday, 11 March 2014 at 15:38:21 UTC, Steven Schveighoffer wrote:
>> An idea -- would it be possible to search links from the D forum, and post underneath the discussions that link to that doc page? Then have some sort of moderation so non-doc-related discussions don't clutter the page? Maybe even just first few sentences of the post, with a link to the D forum...
>>
>> Then we don't have to have any kind of new interface for D posts, just a copy of what's already in discussion.
>
> Sure, we could do that.
>
> Together with an "Ask a question about std.modulename.symbolname" link that goes to a partially pre-filled form ready to post to d.learn.
Oh, excellent idea, even if we don't have the discussion cross-linked.
-Steve
|
March 11, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | W dniu 2014-03-10 04:44, Andrei Alexandrescu pisze:
> Consider it alpha quality. Please don't announce yet before we put it in
> good shape.
>
> https://github.com/D-Programming-Language/dlang.org/pull/516
>
> http://dlang.org/library
Great!
Altough, I would exchange title order to like "std.xxx module" or "someFn() function". Otherwise, identifier names in tabs may be visually cut out if you open many tabs.
|
March 11, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On 2014-03-11 19:03, Andrei Alexandrescu wrote: > Yes to that. I seem to recall we have something similar on the homepage. > > Could you please get something started to serve as a pattern to follow > for all of us? Do you mean how to write Ddoc comments or implement the $(CATEGORY) macro? -- /Jacob Carlborg |
March 11, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Jacob Carlborg | On 3/11/14, 12:08 PM, Jacob Carlborg wrote:
> On 2014-03-11 19:03, Andrei Alexandrescu wrote:
>
>> Yes to that. I seem to recall we have something similar on the homepage.
>>
>> Could you please get something started to serve as a pattern to follow
>> for all of us?
>
> Do you mean how to write Ddoc comments or implement the $(CATEGORY) macro?
>
Implement the macro and show how it works in one place.
Andrei
|
March 12, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | Am 11.03.2014 16:12, schrieb Andrei Alexandrescu:
> On 3/11/14, 6:55 AM, Ivan Kazmenko wrote:
>>> http://dlang.org/library
>>
>> Looks nice!
>>
>> I second the opinion that Disqus might have a better alternative. Its
>> loading after the page was rendered looks clumsy, its style does not
>> match that of dlang.org's... the whole thing is somehow out of place.
>
> Unless something better comes about, we'll go with disqus. Sönke, are
> there styling options available?
>
> Andrei
>
AFAICT the only options are dark or bright background and serif or sans-serif font. I didn't find anything to control the area around the horizontal bar at the top of the comments section.
|
December 11, 2014 Re: ddox-generated Phobos documentation is available for review | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 10 March 2014 at 03:44:54 UTC, Andrei Alexandrescu wrote:
> Consider it alpha quality. Please don't announce yet before we put it in good shape.
>
> https://github.com/D-Programming-Language/dlang.org/pull/516
>
> http://dlang.org/library
>
> http://dlang.org/library-prerelease
>
> I needed to change quite a bit about the makefile. It was building everything over and over again, and it's _slow_.
>
> Some functions are not ready, compare e.g.
>
> http://dlang.org/library/std/algorithm/balancedParens.html
>
> with
>
> http://dlang.org/library/std/algorithm/any.html
>
>
> Andrei
std.container.Array is shadowed by std.container.Array!bool. redBlackTree shadows RedBlackTree as well.
|
Copyright © 1999-2021 by the D Language Foundation