cljdoc

https://cljdoc.org/ & https://github.com/cljdoc/cljdoc
seancorfield 2019-11-15T03:27:24.062600Z

Two questions: 1. I just published 1.0.10 of seancorfield/next.jdbc -- and noticed an unfortunate broken link in the Getting Started docs. I can fix it on GitHub of course, but what will it take to get cljdoc to rebuild the docs from that fixed version? 2. I have a namespace that only contains implementations of protocols, so it has no vars and does not show up in the left hand nav tree of namespaces. I feel like I've asked this before but is there a way to force cljdoc to include such namespaces in the nav tree?

seancorfield 2019-11-15T03:28:39.063800Z

(I suspect the answer to #1 is "You have to release a new build" which seems overkill just to fix a link in the generated documentation 😞 )

martinklepsch 2019-11-15T10:09:57.065500Z

@seancorfield Your suspicion is correct. I wish there was another way but so far I haven’t found a method that I’m completely happy with. This is currently also a ~blocker for Reagent to use cljdoc so probably worth addressing

martinklepsch 2019-11-15T10:10:32.066100Z

There’s an issue for this here, feel free to subscribe and give feedback on solutions have have been proposed thus far https://github.com/cljdoc/cljdoc/issues/31#issuecomment-554298351

martinklepsch 2019-11-15T10:10:39.066400Z

More ideas also welcome 🙂

martinklepsch 2019-11-15T10:16:28.067400Z

Regarding #2 — is the namespace next.jdbc.transaction? If so what would you like to see when viewing that namespace on cljdoc?

martinklepsch 2019-11-15T16:46:56.070600Z

We could add it to the nav if there is a docstring, if you’d like that leave a not here: https://github.com/cljdoc/cljdoc/issues/21

seancorfield 2019-11-15T16:48:05.072Z

Okay I'll add a vote for it there. The actual page renders fine. They're just missing from the nav tree.

martinklepsch 2019-11-15T16:48:51.072900Z

Yeah, at some point I took them out because I thought it doesn’t make sense to just show a namespace’s title. I didn’t consider that there might be an extensive docstring at the time.

seancorfield 2019-11-15T18:51:04.073200Z

Notes added to both tickets.

martinklepsch 2019-11-15T18:53:56.073400Z

Thanks!

martinklepsch 2019-11-15T18:54:04.073800Z

> Can you also make it a bit easier to figure out how to request a cljdoc rebuild? As in the hidden button is too hidden?

seancorfield 2019-11-15T19:08:22.074100Z

There's a hidden button? Where is it?

dominicm 2019-11-15T22:46:19.074300Z

it's white text

dominicm 2019-11-15T22:46:29.074600Z

to the immediate left of the button in the top right.

dominicm 2019-11-15T22:46:32.074800Z

inspect the source

seancorfield 2019-11-15T23:06:38.075100Z

Found it -- thanks @dominicm!