Clojurians Log v2

I also didn't realize that the friendly name used in cljdoc.edn also determines the actual URL, so I have a bunch of links that go to blank pages because I was trying to link to the filename instead 😞 I hadn't noticed because some of my filenames do match the friendly name.

I'm getting there, slowly. I know there will be at least one more round of code changes before I actually announce this thing so I hope I'll have the documentation right by then 🙂

Alpha 7 pushed and all the links are now correct! Yay!

cljdoc is a very nice piece of work @martinklepsch -- thank you! https://cljdoc.org/d/seancorfield/next.jdbc/1.0.0-alpha7/doc/readme

Thanks! Please do open an issue if you have some (semi) specific suggestions to make the docs clearer. Doesn’t have to be polished, more about making a note before we all forget about it again :D

I think the main disconnect -- for me -- was that on GitHub, I'd link to /doc/some-thing.md and I somehow expected that to be magically converted to whatever link cljdoc created for the same file, based on cljdoc.edn... which, after just a little thought, is wildly unrealistic.

@seancorfield but... thats how it works? 😄 I think I'm misunderstanding something

if you link to any md/adoc file that is also part of your cljdoc.edn those links will automatically be rewritten so that they point to their respective cljdoc counterparts

From what I understood the confusion stemmed from having a different expectation how the URLs are defined (i.e. based on title vs filename) but would be interested to understand if there was something else too

Yeah, I think that's it. I assumed that the cljdoc.edn file would provide a two-way mapping so links to actual doc/whatever.md files would be mapped to the URL associated with the "What Ever" name -- what-ever -- but that didn't seem to happen. Should it @martinklepsch?

@seancorfield can you point me to some specific link that you expected to be rewritten? From what I understand this should work but there might be a misunderstanding so it might help to talk about something specific

Hard to say. I took the comment in the docs pretty literally: that rewriting means a link that works on GitHub also works on cljdoc.

So I expected that relative links within the doc/*.md files -- to each other -- would be rewritten to link to the same place in the generated docs on cljdoc itself.

If I had doc/getting-started.md and it linked to just rs-builders.md -- which works on GitHub -- then in the generated docs it would link to /doc/getting-started/result-set-builders per the mapping in cljdoc.edn.

It looks like (all?) attempts to build cljdoc for yetibot https://cljdoc.org/builds/12702 fail during API import due to Too long with no output (exceeded 10m0s).