Fork me on GitHub
#cljdoc
<
2019-12-12
>
borkdude11:12:27

maybe because I have some html files in my doc folder?

borkdude11:12:32

I generated those using codox

borkdude11:12:48

that multimethod should probably have a default value instead of failing

borkdude11:12:30

I just want to make a link in the side menu 😕

borkdude11:12:47

I'll remove it then

borkdude11:12:19

@martinklepsch I don't understand why the page says missing scm info. I think I filled it in in project.clj

martinklepsch11:12:16

> I just want to make a link in the side menu What's in that HTML file that you can't put into a Markdown file?

borkdude11:12:31

codox-generated files

martinklepsch11:12:14

HTML doesn't allow cljdoc to provide a uniform documentation viewing experience. That has downsides and upsides but cljdoc has always taken a stance on the side of consumers in terms of providing a streamlined reading/viewing experience

borkdude11:12:24

makes sense, I've already accepted that. moving on. I still don't understand why the page says missing scm info 🙂

martinklepsch11:12:29

Not sure I understand how cljdoc configuration is related to making the http://github.io page work

borkdude11:12:02

well, my assumption was that making a link in the cljdoc menu would just point to the static file and be done with it

martinklepsch11:12:17

I think that might solely due to the fact that the build failed, here's a build that worked and SCM info is shown properly: https://cljdoc.org/d/borkdude/sci/0.0.11-alpha.14/doc/readme

martinklepsch11:12:44

I'm sorry to dissappoint your assumption here 🙃

borkdude11:12:46

alrighty, I've re-triggered the build now

borkdude11:12:13

no biggie, have a nice day 🙂

martinklepsch11:12:54

Oh and generally I'd be curious why the http://github.io page is important to you, as in what does it get you that cljdoc doesn't already provide?

martinklepsch11:12:49

Ah I see, well that makes sense then 🙂 I guess my recommendation would be adding a page to the doc tree "Java API" that then links to that page

borkdude11:12:26

ehm, that's exactly the thing you just said that didn't work?

martinklepsch11:12:57

I mean doc/java-api.md with some basic information on the Java API and a link to the generated javadocs. This way you keep all info in one place, the java API docs are easy to find and you can still use cljdoc as primary documentation hub with it's API docs for Clojure (in contrast to the github pages where you would have to manually publish Clojure API docs)

borkdude11:12:34

I already have a description of those java docs directly in the README.md

borkdude11:12:55

making an indirection .md file feels like a workaround (but definitely a possible workaround)

martinklepsch11:12:57

Yeah I mean you can also obviously just link to the Java docs from that section (as you already do) but IME adding more stuff to the sidebar helps discoverability of docs a lot

martinklepsch11:12:06

but yeah "depends" 🙂