Cljdoc alpha

Some features shipped recently:

  • Build logs: overview & individual
  • Articles now have an “Edit on GitHub” link at the end of the page (example)
  • If you properly specify your SCM url, we show links to source for each var.
    These links are tied to the specific Git revision for the given version (example)
  • Support for -SNAPSHOT releases
  • Lots of bugs introduced & fixed :sweat_smile:

If you would like to contribute, there are several issues tagged as “Good First Issue”.

If you’d like to contribute but none of these tickle your fancy… join #cljdoc on Slack and say hi! :slight_smile:

There’s also a couple of larger things to think about: data model + storage & coming up with innovative twists on documentation that make it more useful. (Think emphasizing well documented vars/namespaces, examples, etc.)

I’ll personally focus on two things:

  • Tracking releases on Clojars. In order to build docs for every release on Clojars we need to know when new releases are published. Clojars doesn’t have a datafeed for this and I’ll try to either contribute that to the Clojars API or work with their search API if it turns out sufficient.
  • Provide offline bundles. I’m in contact with the creator of Dash (my favorite documentation browser) and it seems that we might get to integrate cljdoc sooner rather than later. As far as I understand this also means cljdoc docsets will be available for Zeal - a cross platform OSS alternative.

See you around :wave:

7 Likes