Thanks for the thoughts Craig. * I'm experimenting with a "namespaces" tab that will complement the current "vars" listing that is available now. * The ability to link in also sounds good, though I'll focus on that once the URL of the docs themselves is stable. * Having online docs opens up a lot of possibilities, including annotations, inter-function linking, and per-var usage stats. We'll see (:
- Mark On Fri, Nov 21, 2008 at 8:00 AM, Craig Andera <[EMAIL PROTECTED]> wrote: > > Very nice! As it turns out, I've been heavily involved in writing the > documentation infrastructure that MSDN uses for the last few years, so > I have some sympathy for this problem space. :) > > A few things I'd like to see: > > * I'd like to see the URL for the page change when navigating to a new > topic. Right now it's pretty hard to bookmark a page or email a URL to > some particular piece of documentation since the URL is always > index.html. > * I want to be able to click on a namespace and see all the symbols > for just that namespace. Would make it easy to explore the libraries > by functional area. > * I'd like to be able to get back to the home page from any other > page, or go up to the namespace page. > * Maybe the namespace page could have snippets of the doc next to the > names. Perhaps the first 30 characters of the doc string or something > simple like that. > * If this supported annotations, that would be fantastic, but > obviously that's a whole 'nother level. > > On Fri, Nov 21, 2008 at 3:17 AM, Mark McGranaghan <[EMAIL PROTECTED]> wrote: >> >> I've created some experimental HTML docs for Clojure. You can see them >> on S3: >> http://clj-doc.s3.amazonaws.com/tmp/doc-1116/index.html >> >> Or, just for kicks, on Amazon's new Cloud Front CDN: >> http://d2nbqsesuabw8o.cloudfront.net/tmp/doc-1116/index.html >> >> You can see the code I used to generate them on GitHub: >> http://github.com/mmcgrana/clj-doc >> >> The generation code is open for public perusal but will require some >> tweaking for public use (e.g. I still have paths hard coded). Any help >> along these lines would be greatly appreciated. >> >> Most methods in the clj-doc source have docstrings and in total its >> only a couple hundred lines of code: you should be able to find your >> way around if you're interested. The best entry point is bin/gen.clj. >> Again, any comments or suggests would be appreciated. >> >> I hope that some of you find this interesting/useful/helpful in your >> Clojure endeavors, >> - Mark >> > >> > > > > --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Clojure" group. To post to this group, send email to clojure@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/clojure?hl=en -~----------~----~----~----~------~----~------~--~---
