An effort to create a central documentation hub for the Clojure & ClojureScript ecosystem.
- An update (read this first): Hello everyone 👋
- The old README can be found under
doc/OLD_NOTES_MARTIN.md
TODO (:sweat_smile:)
- an ecosystem-encompassing Grimoire store serves as single source of truth
- that Grimoire store is updated when new releases are published to Clojars or other relevant information changes
- various tools can be built on top of data in this Grimoire store
- it acts as a repository for static analysis done on Clojure code
I've been looking for an opportunity to use ADRs for some time, you can find them all in doc/adr/.
-
build.bootcontains various entry points into the code, most interesting is probablybuild-docswhich you can run withboot build-docs --project bidi --version 2.1.3 target- After that there will be a bunch of stuff in
target/which you may want to look at. - There are various sub-tasks that address different aspects of building documentation. I hope reading
build-docswill give you a quick overview about all the things going on.
- After that there will be a bunch of stuff in
-
There are various specs defined in
cljdoc.spec. -
Code that needs to be loaded for analysis is in
cljdoc.analysis. -
The cache that serves as input to renderers is defined in
cljdoc.cache -
Overall resource/routing model is defined in
cljdoc.routes.
I often choose to refer to functions with their fully qualified name. I hope this makes reading the code easier.
I outlined some areas that could use help in CONTRIBUTING.md
We use aero for configuration and several modes of operation are possible:
-
You should always, without any further steps be able to clone this repo and generate documentation locally using:
boot build-docs --project bidi --version 2.1.3 targetIf this does not work, it's a bug.
-
The cljdoc API server requires some additional configuration as it will upload files to an S3 bucket and run analysis of jars on CircleCI instead of on the local machine. The additional configration can be placed into
resources/secrets.ednor supplied via the environment variables specified in that file. Once these steps are completed you should be able to run the server usingCLJDOC_PROFILE=live boot start-api
EPL-2.0 see LICENSE