Thread overview | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
September 04, 2017 dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Attachments:
| I've seen a lot of dub projects with embedded ddoc that follows phobos example. These projects are then hosted on code.dlang.org, but often, the docs are never generated and hosted anywhere. In the event they are, links to docs are ad-hoc and unpredictable, and the formatting/styling/etc is not standard/consistent. Suggest; code.dlang.org should attempt to generate ddoc for each hosted project, host it, and clearly link to it from the project front-page. Hosted docs should be styled consistently (matching phobos?). Thoughts? - Manu |
September 04, 2017 Re: dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Manu | On Monday, 4 September 2017 at 10:47:47 UTC, Manu wrote: > I've seen a lot of dub projects with embedded ddoc that follows phobos > example. > These projects are then hosted on code.dlang.org, but often, the docs are > never generated and hosted anywhere. > In the event they are, links to docs are ad-hoc and unpredictable, and the > formatting/styling/etc is not standard/consistent. > > Suggest; code.dlang.org should attempt to generate ddoc for each hosted project, host it, and clearly link to it from the project front-page. Hosted docs should be styled consistently (matching phobos?). > > Thoughts? > - Manu While it's an interesting suggestion, dub has 355 open issues, would be better if more people pitched in on those: https://github.com/dlang/dub/issues |
September 04, 2017 Re: dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Manu | On Monday, 4 September 2017 at 10:47:47 UTC, Manu wrote: > I've seen a lot of dub projects with embedded ddoc that follows phobos > example. > These projects are then hosted on code.dlang.org, but often, the docs are > never generated and hosted anywhere. > In the event they are, links to docs are ad-hoc and unpredictable, and the > formatting/styling/etc is not standard/consistent. > > Suggest; code.dlang.org should attempt to generate ddoc for each hosted project, host it, and clearly link to it from the project front-page. Hosted docs should be styled consistently (matching phobos?). > > Thoughts? > - Manu It has existed in the past, see http://forum.dlang.org/thread/weuxppabkrreaxbqqpdv@forum.dlang.org?page=1 |
September 04, 2017 Re: dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Manu | On 2017-09-04 12:47, Manu via Digitalmars-d wrote: > I've seen a lot of dub projects with embedded ddoc that follows phobos example. > These projects are then hosted on code.dlang.org <http://code.dlang.org>, but often, the docs are never generated and hosted anywhere. > In the event they are, links to docs are ad-hoc and unpredictable, and the formatting/styling/etc is not standard/consistent. > > Suggest; code.dlang.org <http://code.dlang.org> should attempt to generate ddoc for each hosted project, host it, and clearly link to it from the project front-page. > Hosted docs should be styled consistently (matching phobos?). > > Thoughts? Yes please :) -- /Jacob Carlborg |
September 04, 2017 Re: dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Manu | On Monday, 4 September 2017 at 10:47:47 UTC, Manu wrote:
> I've seen a lot of dub projects with embedded ddoc that follows phobos
> example.
> These projects are then hosted on code.dlang.org, but often, the docs are
> never generated and hosted anywhere.
> In the event they are, links to docs are ad-hoc and unpredictable, and the
> formatting/styling/etc is not standard/consistent.
>
> Suggest; code.dlang.org should attempt to generate ddoc for each hosted project, host it, and clearly link to it from the project front-page. Hosted docs should be styled consistently (matching phobos?).
>
> Thoughts?
> - Manu
+1
|
September 05, 2017 Re: dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Posted in reply to user1234 Attachments:
| On 4 September 2017 at 21:45, user1234 via Digitalmars-d < digitalmars-d@puremagic.com> wrote:
> On Monday, 4 September 2017 at 10:47:47 UTC, Manu wrote:
>
>> I've seen a lot of dub projects with embedded ddoc that follows phobos
>> example.
>> These projects are then hosted on code.dlang.org, but often, the docs are
>> never generated and hosted anywhere.
>> In the event they are, links to docs are ad-hoc and unpredictable, and the
>> formatting/styling/etc is not standard/consistent.
>>
>> Suggest; code.dlang.org should attempt to generate ddoc for each hosted project, host it, and clearly link to it from the project front-page. Hosted docs should be styled consistently (matching phobos?).
>>
>> Thoughts?
>> - Manu
>>
>
> It has existed in the past, see http://forum.dlang.org/thread/ weuxppabkrreaxbqqpdv@forum.dlang.org?page=1
>
Seems to be gone.
If people think this is sensible, I'd go as far as saying this would be a
major ecosystem usability improvement, and maybe even worthy of paid
attention... (Andrei?)
|
September 05, 2017 Re: dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Manu | On Monday, 4 September 2017 at 10:47:47 UTC, Manu wrote: > I've seen a lot of dub projects with embedded ddoc that follows phobos > example. > These projects are then hosted on code.dlang.org, but often, the docs are > never generated and hosted anywhere. > In the event they are, links to docs are ad-hoc and unpredictable, and the > formatting/styling/etc is not standard/consistent. > > Suggest; code.dlang.org should attempt to generate ddoc for each hosted project, host it, and clearly link to it from the project front-page. Hosted docs should be styled consistently (matching phobos?). > > Thoughts? > - Manu Mir uses http://docs.algorithm.dlang.io/latest/index.html for its docs. Perhaps something like it could be extended for other projects? I think Sebastian Wilzbach would be the person to contact about this. |
September 05, 2017 Re: dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Nicholas Wilson | On Tuesday, 5 September 2017 at 02:21:26 UTC, Nicholas Wilson wrote:
>
> Mir uses http://docs.algorithm.dlang.io/latest/index.html for its docs. Perhaps something like it could be extended for other projects?
> I think Sebastian Wilzbach would be the person to contact about this.
However it is that it works, I've always liked the look of mir's documentation pages.
|
September 05, 2017 Re: dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Joakim | On Monday, 4 September 2017 at 11:15:08 UTC, Joakim wrote:
> While it's an interesting suggestion, dub has 355 open issues, would be better if more people pitched in on those:
I have zero interest in fixing dub issues since I have zero interest in using dub.
If one of the libraries were compelling... and I actually knew about it though, that equation may change.
Making the code repository show documentation will do a lot to make the library more discoverable and valuable, which in turn, can drive dub use and bring with it more contributors.
I think this is a good idea (and I bought a VM to set up to do it myself, but I went too cheap and the 512 MB of memory isn't enough to actually build the docs! ugh.)
|
September 05, 2017 Re: dub projects generate docs and host on code.dlang.org? | ||||
---|---|---|---|---|
| ||||
Posted in reply to Manu | On Monday, 4 September 2017 at 10:47:47 UTC, Manu wrote:
> I've seen a lot of dub projects with embedded ddoc that follows phobos
> example.
> These projects are then hosted on code.dlang.org, but often, the docs are
> never generated and hosted anywhere.
> In the event they are, links to docs are ad-hoc and unpredictable, and the
> formatting/styling/etc is not standard/consistent.
>
> Suggest; code.dlang.org should attempt to generate ddoc for each hosted project, host it, and clearly link to it from the project front-page. Hosted docs should be styled consistently (matching phobos?).
>
> Thoughts?
> - Manu
It would be really useful feature!
|
Copyright © 1999-2021 by the D Language Foundation