Hey all! does anyone have advice on how to preview docs as you write them?

I know there is the more hardcore preview with the docker image, ingesting a jar, etc

@sritchie09 the “hardcore preview” 😄 is the only supported way

if you only want to preview an article you can also use previewers for markdown/asciidoc

looking to validate all my links etc

yeah, probably best to follow the steps outlined here: https://github.com/cljdoc/cljdoc/blob/master/doc/running-cljdoc-locally.adoc#testing-docs-for-a-library-during-development

okay, nice, thank you!

strangely I’m seeing

No method in multimethod 'filepath->type' for dispatch value: null

could it be you have a cljdoc.edn that isn’t valid?

e.g. has a :file key that’s nil or similar?

I’m cutting my cljdoc.edn down to bare bones to check it out, visually it LOOKS like all files are here (though I may have a typo)

@sritchie09 https://github.com/cljdoc/cljdoc/blob/master/script/verify-cljdoc-edn

amazing @martinklepsch, very helpful!

it found my typo

excellent

arguably not the best error message 😄

I’m going through this myself, looking for a nice pattern to expose solid default error messages for multimethods

thanks for getting me unstuck here

and for this wonderful library, etc etc!

welcome & thanks 🙏

@martinklepsch, sorry to come running back… strangely the preview is still failing with the same exception. I do wish I could see which file, or entry, it is trying to get an extension for and failing

https://gist.github.com/sritchie/c5f25ba2b9fadd19fffa4cf8c619ccb7

this is my TOC - the checker you sent passes just fine

maybe the empty dicts are a problem? I took that style from https://github.com/metosin/reitit/blob/master/doc/cljdoc.edn

I also have all .adoc files… only asking here since there is serious latency on checking via the docker method

oh, you know what - I bet it’s that I haven’t committed

yup, not committing would do it, the documentation building always operates on a specific Git rev

it looks like adoc files don’t show their title on the page, is that right?

= How to Use SICMUtils

How do you use this?

- Library
- Notebook
- Clojurescript (see cljs page)
- Shell (via GraalVM)

for that file

that looks odd to me

https://cljdoc.org/d/cljdoc/cljdoc/0.0.1315-c9e9a7e/doc/userguide/for-library-authors

looks like this is true on the cljdoc docs page too

https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc

here’s the raw file

hm, that’s weird

Oh I thought it was supposed to look like that

I also experience this

I can probably look at that sometime this weekend