cljdoc

https://cljdoc.org/ & https://github.com/cljdoc/cljdoc
borkdude 2019-10-16T13:51:39.000500Z

out of curiosity: does cljdoc also show javadocs for java sources in clojure projects?

borkdude 2019-10-16T13:51:47.000800Z

I'm working on a Java API for one of my projects

martinklepsch 2019-10-16T13:52:59.001100Z

@borkdude not in scope, sorry!

borkdude 2019-10-16T13:53:35.001700Z

can probably hack around that by generating some markdown from javadoc or something

martinklepsch 2019-10-16T13:54:14.002500Z

Happy to discuss if you feel thereโ€™s a strong case for it but my intuition is that cost/benefit just doesnโ€™t make much sense given the average Clojure library

borkdude 2019-10-16T13:54:42.003200Z

you might be right

martinklepsch 2019-10-16T13:54:51.003400Z

Generating documentation to markdown files ๐Ÿ‘Œ ๐Ÿ˜„ Boot does that too, worked pretty well

borkdude 2019-10-16T13:55:24.003800Z

or I'll just informally create an example. Java people have IDEs ๐Ÿ˜œ

๐Ÿ˜‚ 1
wilkerlucio 2019-10-16T17:53:31.007400Z

@martinklepsch hello ๐Ÿ™‚ I was having the wish to have some attribute documentation on cljdoc, in that I mean, having a section of the docs dedicated to talk about the keywords with spec information, this could include: 1. list of qualified keywords are used in the project (maybe even those without spec) 2. describe specs for keywords that have it 3. using data from fspec / fdef it could generate a list of functions where that keyword is mentioned I have done something similar for Pathom (https://wilkerlucio.github.io/pathom/v2/pathom/2.2.0/connect/exploration.html). what do you think about having something like this in cljdoc?

jaihindhreddy 2019-10-17T13:48:18.011300Z

Could also have inline example generation for specced stuff.

seancorfield 2019-10-16T21:00:30.007900Z

@wilkerlucio Couldn't you just write that up in the doc folder in your repo?

seancorfield 2019-10-16T21:01:52.009100Z

Oh, you specifically want it auto-generated from the source?

seancorfield 2019-10-16T21:02:48.010Z

I'm not sure how valuable auto-generated data would be -- I would expect it to need more curation?