Clojurians Log v2

hi there! new to cljdoc, but really invigoratingly awesome effort. im gonna take the plunge here pretty soon regardless, but im curious about how you (@martinklepsch) are thinking about something i could see myself running into. ive looked for examples of this, but havent found much yet (but maybe have been looking in the wrong places). ive got a few libraries that have JS APIs as well, but the articles ill be writing will apply to usage from all hosts. so the urge is to put JS examples adjacent to to the CLJ/S examples. would having some JS documentation sprinkled in violate any sort of mechanical or conceptual integrity of cljdoc? i dont have any existing (formal) documentation, otherwise linking out might make more sense. since this is a new documentation effort, id love for it all to be in a central place. i noticed that datascript has a relatively thin wiki article on the JS API in github, but no mention of it in the cljdoc. it may be a stupid question (either: "duh, just put it in there!" or "keep your JS to yourself!"), just trying to get an idea of how you're thinking about this. this is probably related to the javadoc discussion literally inches above this ^, but just 👌 slightly different? since from what i can tell, there was existing documentation in the mix. in any case, apologies if this should be considered a duplicate

separately, cljdoc is truly gorgeous to read

i mean wow.

It's up to you I guess. I wouldn't expect cljdoc to do much analysis necessarily. You could hide the js examples using asciidoc #ifdef

right on. thats what i had suspected would be the response, but just wanted to toss it out there and see what came back. thanks @dominicm.

@nolan it’s unlikely that cljdoc will integrate analysis/api docs for Java or JavaScript on time horizon that is relevant for you. I personally tend to consider them out of scope but I’m also not going to be in anyone’s way if they have a strong urge to push this.

What you can do for now is putting JS API docs into markdown/asciidoc files and potentially generate those files using a third party tool

oh, yeah, i dont even think id really use or urgently desire JS analysis tools. itd be more about any conceptual impedance of having any sort of JS documentation on cljdoc, if that was some sort of sin or whatnot

If you think it’s helpful for the users of your thing it’s wanted on cljdoc :)

epic epic epic. thanks again. looking very forward to working with it. absolutely loved the talk at clojuretre on it...just rewatched it again and got all fired up about docs

Very happy to hear!

Looking forward to see what you‘ll make ☺️