Fork me on GitHub
#cljdoc
<
2018-11-17
>
Vincent Cantin12:11:54

[intent: just chatting] [definitely off topic] I have an idea a little crazy .. there is this browser called [beaker browser](https://beakerbrowser.com/) which is good at updating and displaying offline static sites. I am wondering if in the long term it would be a good target for a fully offline user experience. However, I think that cljdoc would need a lot of changes to fit that project.

martinklepsch13:11:51

I've seen beaker browser and it definitely seems cool. Just wondering, have you already seen cljdoc's offline bundles? https://cljdoc.org/download/manifold/manifold/0.1.8

Vincent Cantin13:11:21

I just took a look and that's pretty good. A port to Beaker is within reach.

Vincent Cantin13:11:34

The bundles in cljdoc have to be downloaded in advance one by one by the user, so s/he needs to know what s/he wants ahead of time.

Vincent Cantin13:11:29

With the beaker port, the user could in theory just update the whole set of documentation using a single interaction while still online, and can decide later which library s/he need to read. Note: I have zero experience using beaker as a website programmer, I don't know if the data size of a website has a limit on it.

Vincent Cantin13:11:03

Does cljdoc have a uber-all-projects downloadable offline bundle?

martinklepsch13:11:58

It doesn't at this time

Vincent Cantin14:11:52

I am trying to get the project running on my computer and it runs, but there are some errors displayed in my terminal, I don't know if it is to be expected or if I have a wrong setup.

Vincent Cantin14:11:03

This is the current master branch.

Vincent Cantin14:11:53

The errors in the log did not show any problem from the browser's user's perspective.

Vincent Cantin15:11:24

My feedback on the "get started" process for new comers: When I followed the instructions to run the server locally, I ran into a small problem where the website complained that I did not built the JS files, even if I did it already. The problem disappears after I interrupted the server and restarted it, with the js file already been built. I followed the chronological order of the documentation. Maybe I needed to build the JS files before running the server to avoid the problem.

Vincent Cantin15:11:48

Contribution workflow question: I found some minor typos in the project, should I point to them via comments in Github or do a PR?

martinklepsch15:11:38

> I followed the chronological order of the documentation. Maybe I needed to build the JS files before running the server to avoid the problem. Another contributor also ran into that issue. I think the problem is that resources-compiled doesn't exist when the server (or process) is started. If it's about the server then we could probably just .mkdir it before starting the server. If it's the process we should update the documentation. But generally the more independent those things are the better.

martinklepsch15:11:02

So did you restart the entire clj process or just the system?

Vincent Cantin00:11:16

I barbarianly pressed Ctrl+C on ./script/cljdoc run then ran it again.

martinklepsch15:11:30

> Contribution workflow question: I found some minor typos in the project, should I point to them via comments in Github or do a PR? (edited) PR is easier to integrate, also happy to give you commit access if you're worries about to many PRs creating noise

Vincent Cantin00:11:43

I made a PR, then.