clojure-grimoire / grimoire

Community documentation of Clojure
http://conj.io
159 stars 41 forks source link

Use from dash #254

Open LukeDefeo opened 7 years ago

LukeDefeo commented 7 years ago

Hey great docs and examples, would be great if I could use it from dash

arrdem commented 7 years ago

I've thought about doing this in the past. I personally have no interest in this feature, but it could certainly be implemented using only lib-grimoire as it exists currently.

Grimoire was originally conceived to be a web documentation resource that Sucked Less(TM) so that I could give people links to better docs when talking in IRC/Slack. That purpose the existing app serves.

I am personally irked by the fact that I basically can't write Clojure when I'm fully offline without reading the source code for libraries I'm interacting with. In my experience CIDER's arity completion, autocompletion and autodoc features are ... unreliable at best . clojure-grimoire/lib-grimoire#18 is a long standing idea for how to start enabling users to take Grimoire offline by providing and using a local filesystem cache so that Grimoire docs can be rapidly re-fetched as the primary data source rather than as an alternate. This does introduce all the usual cache invalidation concerns which is part of why I've never implemented it.

Part of my objection to re-packaging Grimoire's content for other sources is essentially that I wrote ~9X% of these documents to deliver the service that is Grimoire. Why would I repackage this work for Dash (a non-free app) without compensation? Under CC0, the license on the data store, I can still charge for a packaging such as a dash export.

But yeah you could totally use grimoire.api/search to pull out all Defs in the datastore and stick 'em in a Dash-compatable SQLite package.

LukeDefeo commented 7 years ago

Would you mind if I attempted to try this, or it is against a license?

LukeDefeo commented 7 years ago

obviously any credit would go to you and the website

arrdem commented 7 years ago

Under CC0 you are free to do this.