SyliusResourceBundle icon indicating copy to clipboard operation
SyliusResourceBundle copied to clipboard

Update examples and docs

Open KingMob opened this issue 1 year ago • 0 comments

First, while the aleph.io literate documentation site is cool, we aren't currently keeping it up-to-date, and would have to bug Zach for access if we wanted to. On top of that, in recent years, cljdoc.org has emerged as the standard bearer for clj documentation. I'd like to convert the examples and literate docs into articles or something so that users of cljdoc.org can read them.

Along with that, the current routing in examples is based off Compojure, which is not very popular these days. I'd like to switch to reitit, or something more data-driven.

To do:

  • [ ] (Optional) Get local cljdoc building working, if you haven't before
  • [ ] Bring aleph.io docs to cljdoc.org
  • [ ] Convert example routing to reitit
  • [ ] Fix the examples' to follow the clojure style guide

KingMob avatar Sep 21 '22 04:09 KingMob