This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2023-07-10
Channels
- # announcements (28)
- # architecture (1)
- # babashka (4)
- # beginners (55)
- # biff (4)
- # calva (11)
- # clerk (1)
- # clj-http (2)
- # clj-kondo (1)
- # clojure (46)
- # clojure-austin (1)
- # clojure-europe (32)
- # clojure-nl (1)
- # clojure-norway (17)
- # clojure-uk (4)
- # clojurescript (5)
- # cursive (6)
- # datomic (2)
- # emacs (2)
- # events (1)
- # fulcro (33)
- # hoplon (4)
- # humbleui (30)
- # hyperfiddle (50)
- # jackdaw (2)
- # jobs (13)
- # joyride (8)
- # lsp (2)
- # malli (2)
- # off-topic (6)
- # re-frame (4)
- # remote-jobs (1)
- # rum (10)
- # shadow-cljs (10)
- # xtdb (7)
I'm considering writing literate programming docs for each file in the default Biff template. That means all of the files listed at the beginning of the https://biffweb.com/docs/reference/architecture/. Here's an example of how the docs would be formatted: http://gdeer81.github.io/marginalia/. I expect these comments would not be included when you actually generate the code, they would only be for external documentation. Also, this is just for the generated Biff template files, not the Biff API itself. Pros: • Provides an alternative path for people who want to learn by jumping directly into code. • It would be a quick reference when learning and memorizing what each file is for. • I want to standardize all my projects to follow the Biff architecture and this would serve as an informal standard for what that means, even if I'm not starting from scratch. Cons: • More docs to maintain (I'm happy to help out here) • Need to add functionality to the Biff repo to generate these docs Thoughts?
sounds worth experimenting with. I'm only mildly familiar with literate programming. maybe create a new biff project in a public repo and document a few of the files, for demonstration?