Fork me on GitHub
#cljdoc
<
2023-08-02
>
djblue04:08:29

I'm getting a 500 on doc builds https://cljdoc.org/builds/70831, I feel like this has happened before but I can't remember the cause :thinking_face:

seancorfield05:08:50

So cljdoc was unable to start a new build at all... I've seen other people complaining about problems with CircleCI tonight so maybe it's a "them" problem, not a "you" problem?

seancorfield05:08:41

CircleCI don't seem to think anything is systematically wrong https://status.circleci.com/ 🤷:skin-tone-2:

lread11:08:19

@U1G869VNV I just tried a rebuild on your docs and it seems good now.

lread11:08:23

CircleCI must have had a temporary issue there.

lread11:08:05

I do notice you are another one who has hit this issue tho: https://github.com/cljdoc/cljdoc/issues/743

tengstrand09:08:52

Articles that are included in doc/cljdoc.edn will be converted to cljdoc pages. I have an .adoc file in my repo under the doc directory, among my other articles, that I don't want to include in the left menu, but I want it to be generated, because one of the documents links to it. Is that possible? Right now, the link takes me to the file in github, instead of staying in cljdoc.

lread11:08:10

Interesting. No, not currently.

tengstrand04:08:16

I merged the two pages for now, but it would be great if it worked.

lread10:08:08

To my knowledge, we've not had a request for this ability yet. (I'm not at all saying it is a bad idea, but we try to add features that folks generally ask for/want/need because we have to maintain/support what we add forever) Without knowing more, if it were me, I think I'd maybe make it a sub doc instead of trying to hide it: • doca ◦ sub-doca Would that be a good compromise? Or is sub-doca referenced throughout your other docs? If so I might put it under an appendix-ish heading. • doca • docb • docc • appendix ◦ sub-doca Would either of these compromises work for you? If not, to help me understand your use case, what makes sub-doca inappropriate for your table of contents?

tengstrand14:08:07

This is not super important for me, and you can skip this if it's not requested by other users. The use case is this. I have an idea to have a flat structure in the left menu, except for reference pages at the bottom. Today the https://polylith.gitbook.io/poly/workflow/continuous-integration Continuous Integration page has a link "here" in the beginning, linking to the page that describes the CI setup of the Polylith workspace itself. I wanted it to look the same, and the page is not important enough for most users, to have it visible all the time in the left menu.

lread16:08:36

Ok, cool if not having this feature is not really bugging at least a few cljdoc users, I'm happy to not implement it! But lurkers, do chime in if you have a super strong interest. So I don't lose the thought: if we were to implement this, a reader of docs might wonder why an article they had navigated to was not reflected in the toc. They might assume something was broken/amiss.

👍 2