Fork me on GitHub
#planck
<
2019-05-20
>
pyrmont23:05:45

@mfikes Did you want help with #930 or have you already started and created the issue mostly as a to-do item? I can start going through and pulling stuff out.

mfikes23:05:31

I haven't started on it. Feel free to assign to yourself and dig into it.

pyrmont23:05:05

I did have a question about what documentation should exist on the site itself. The user guide is no longer linked directly from the front page but in the cljdoc docs there are still links to it. On the other hand, all the user guide pages appear to be listed on cljdoc as articles. So maybe all the documentation is supposed to just be there now?

mfikes23:05:04

Yeah, I think that in the end, the http://planck-repl.org site might be just a shell of what it used to be (a place for the main page, a place to host downloads, etc.). I see no issue if all the user guide articles and (especially) all the SDK documentation live on cljdoc.

mfikes23:05:22

(When http://planck-repl.org was created, cljdoc didn't yet exist IIRC.)

mfikes23:05:06

At a high level, I think we only need to retain the article *.md files, and the main thing that can go is all the manually written SDK docs

pyrmont23:05:23

I'll miss the single page guide. I found that helpful for searches. I'm looking at cljdoc on my phone and maybe that's why but it doesn't appear to have its own search functionality.

mfikes23:05:29

script/build should still work so script/deploy can push out the main high level page or two

mfikes23:05:55

Ahh, yeah, that's a good point. In a single page you can find things easily. 🙂

pyrmont23:05:57

But having said that, automated documentation and having everything in one place is a win.