Fork me on GitHub
Jungwoo Kim00:04:50

Hi! Is it possible to host a private documentation for the companies project? I love cljdoc documentation and things but as I found so far, it only offers for public.


Hi @U02SKL96W1J! To host private docs you’d have to setup your own cljdoc server at your company. This is certainly possible but not trivial.

Jungwoo Kim01:04:51

Ahh I got it! thank you for letting me know! 🙂

👍 1
Cora (she/her)17:04:54

very much an aside but part of this search work has me pulling functionality out of request handlers and making them available as functions. ideally, for me, request handlers should be doing as little as possible such that they only contain the things that are specific to http request handling

Cora (she/her)17:04:29

you can see the two parts I pulled out in that file

Cora (she/her)17:04:30

so things like extracting parameters, loading things from the config, etc, can be in the handler but there are only one or two function calls. that way the request handling details are decoupled from the functionality

Cora (she/her)17:04:10

I've noticed this a lot in clojure projects, fwiw. there doesn't seem to be much of a sense of where to separate things within request handlers. in ruby, at least, there's a strong focus on request handlers being as simple as possible

Cora (she/her)17:04:55

in the rails world they have a phrase for it: "fat model, skinny controller"

Cora (she/her)17:04:38

but really it's about separation of concerns and making code as re-usable as possible

Cora (she/her)17:04:30

I think in a functional world that's even more important since we can compose functions so easily it makes re-use even more valuable

Cora (she/her)18:04:31

my thoughts aren't 100% fully formed but I thought I'd share


Cool, more unit-testable too, I assume.

Cora (she/her)21:04:15

maybe we should split single docset search from finding functions/namespaces by name

Cora (she/her)21:04:35

I'm having such a hard time getting the search to work like I'd expect

Cora (she/her)21:04:08

lunr offers highlighting but the search isn't as good. flexsearch has fantastic search but no highlighting

Cora (she/her)21:04:02

really, funding the right function/namespace could be like a fuzzy finder with some levenshtein distance checks, but searching docs is more of a full-text search problem

Cora (she/her)21:04:08

and I think this is why I'm struggling

Cora (she/her)21:04:31

think of it like searching a project on github vs hitting t and doing fuzzy file finding


And then there are the docstrings too.


I’m not sure what kind of sophistication cljdoc users would be expecting. They’ll probably be very happy with whatever first cut you come up with! Maybe if you tokenize in such a way that both words and symbols can be found, you might have a good first cut?

Cora (she/her)22:04:49

that's the thing, they're not terribly configurable

Cora (she/her)22:04:25

i'll need to play around more


hey waddya think of?


(this is in the theme of libraries search work and the idea you should see the freetext content that you are searching)

Cora (she/her)23:04:54

it could use some spacing and increase in font size, I think

Cora (she/her)23:04:52

maybe put clojars on the same line as the version and move view docs down beneath it

Cora (she/her)23:04:18

it's pretty sweet

Cora (she/her)23:04:28

I like that I can see the description