Clojurians Log v2

Hey @nick.matthews— I've sent @devth a message about this: [...] for Yetibot I think the issue might be that some thread pools are started in the background. There seems to be some dirigiste / manifold stuff — if you want to look into it I'd suggest you look out for that kind of stuff To test stuff you can clone this repo: https://github.com/cljdoc/codox/tree/cljs-proper/codox make sure you check out the cljs-proper branch and then run clj -Sdeps '{:deps {yetibot {:mvn/version "0.5.18"}}}' -m codox.main clojure yetibot-0.5.18.jar with a version that you've installed into your local maven

Happy to help with this but wanted to wait of Trevor has some ideas where those threads might be coming from

@seancorfield fyi you can also link to the latest version with a much shorter link like this: https://cljdoc.org/d/seancorfield/next.jdbc

This will automatically redirect to the first article at the latest RELEASE version

Yeah, but that doesn't show up in the browser address bar for easy copy'n'pasting 🙂

That's true, just wanted to mention it in case the long links bothered you 😄

I dug a bit more into this and found a bug that's now fixed in production. Tested it with these changes to the next.jdbc repo: https://github.com/seancorfield/next-jdbc/compare/master...martinklepsch:cljdoc-fixes?expand=1

they're not complete but hopefully helpful enough

In general that "if a link works on github it should work on cljdoc" thing is true and if it isn't, that's a bug 🙂

Nice! Thank you for such a swift fix!

I've done a full regex find'n'replace to fix them all for the next release (rather than take the partial PR). I have more documentation to write (the whole datafy/`nav`/`:schema` thing needs its own page). And, of course, I can only update all the docs when I make a new release 🙂 Alpha 9 contained one tiny bug fix -- and a lot of documentation updates. Alpha 10 will probably be similar, depending on when (if? 🙂 ) I find the next bug!

sounds great!

Note that you can also build docs locally for previewing: https://github.com/cljdoc/cljdoc/blob/master/doc/running-cljdoc-locally.md#importing-a-project-from-local-sources

and (unrelatedly) that you can use [[with-transaction]] to link to other vars in docstrings like this one: https://cljdoc.org/d/seancorfield/next.jdbc/1.0.0-alpha7/api/next.jdbc#transact

(for other namespaces the sym needs to be fully qualified)

Yeah, I haven't started using WikiLinks in docstrings yet. That's on my list, now that I have cljdoc mostly under my belt 🙂

And good to know re: local building... I will check that out tomorrow!

@martinklepsch Why does this URL show the Alpha 9 readme? https://cljdoc.org/d/seancorfield/next.jdbc/1.0.0-alpha5/doc/readme - it doesn't! But the readme includes badges that are dynamic and therefore confusingly show the current version 😐

I guess I'll have to add text to the README to make that less confusing... Does anyone run into this? Or have suggestions to make it less confusing?

Happy to consider ideas to make this less confusing - we can do whatever with the articles. We could just remove the badge if it’s there but not sure if that’s such a great idea

ifdef::env-github[]
image::<http://cljdoc.org/badge.png|cljdoc.org/badge.png>
endif::[]

Oh right, Asciidoc already has a solution

The natural solution is always to rewrite everything in adoc

would it be less confusing if the badge just said "cljdoc" without the version number?

right that may also be an option, given that it generally links to the latest version anyways

For now, I changed my README to say

The latest versions on Clojars and on cljdoc:

<<badges go here>>

This documentation is for 1.0.0-alpha9.

cool 🙂 asciidoc is pretty nice on cljdoc as well, just FYI: https://cljdoc.org/d/nrepl/nrepl/0.6.0/doc/usage/server

But it's fairly common for project READMEs to contain the Clojars badge (and possibly other version-specific dynamic badges) so I think some sort of rewriting is going to be needed ...

Does GitHub know how to render a README written in AsciiDoc?

sure

just click the github link in the top right corner of the nrepl docs and you can see what that looks like (or the edit on github link at the end of the page I linked)

OK, maybe I will do that then (it'll make me learn it at long last 🙂 )

Oh, and the badge thing... https://cljdoc.org/d/nrepl/nrepl/0.5.3/doc/readme

nREPL's README is markdown, not adoc, BTW.

The callouts with tips, warnings and all that are super nice