[racket] Linking to docs for Planet2 packages

From: Jay McCarthy (jay.mccarthy at gmail.com)
Date: Tue Feb 26 07:34:04 EST 2013

This is one of the items on the list of future work:

http://docs.racket-lang.org/planet2/Future_Plans.html#%28part._.Long_.Term%29

It's not trivial because (a) the package system only ships source, not
compiled things like docs; (b) packages can have many Scribble documents as
their documentation; and (c) the main distribution mechanism, Github, is
designed for source and not HTML. Obviously it would be trivial to allow
package authors to add a link in their package description to docs
somewhere, but that wouldn't be very robust and would put a lot of work on
them.

Jay


On Mon, Feb 25, 2013 at 10:39 AM, Michael Wilber <mwilber at uccs.edu> wrote:

> Hey there!
>
> Is there any convention for linking to docs from planet2's online list
> of packages?
>
> E.g. as a user, it would be nice to have a "Click here to see
> documentation" link from, say,
> https://pkg.racket-lang.org/info/disassemble that either links to the
> scribbled docs in the source or to a URL specified by the package author
> in info.rkt or somewhere.
> ____________________
>   Racket Users list:
>   http://lists.racket-lang.org/users
>



-- 
Jay McCarthy <jay at cs.byu.edu>
Assistant Professor / Brigham Young University
http://faculty.cs.byu.edu/~jay

"The glory of God is Intelligence" - D&C 93
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.racket-lang.org/users/archive/attachments/20130226/744e8342/attachment.html>

Posted on the users mailing list.