Skip to content

Commit

Permalink
Convert onwards notebook to markdown & update
Browse files Browse the repository at this point in the history
  • Loading branch information
mk committed Dec 7, 2021
1 parent ebc8f99 commit 8979ce7
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 82 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,4 @@ The will start everything needed to develop Clerk. You can connect your favorite

## 🐞 Known Issues

See [notebooks/onwards.clj](https://github.com/nextjournal/clerk/blob/main/notebooks/onwards.clj).
See [notebooks/onwards.md](https://github.com/nextjournal/clerk/blob/main/notebooks/onwards.md).
2 changes: 1 addition & 1 deletion dev/user.clj
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
(set-dev! false)
(set-dev! true)

(clerk/show! "notebooks/onwards.clj")
(clerk/show! "notebooks/onwards.md")
(clerk/show! "notebooks/rule_30.clj")
(clerk/show! "notebooks/how_clerk_works.clj")
(clerk/show! "notebooks/pagination.clj")
Expand Down
77 changes: 0 additions & 77 deletions notebooks/onwards.clj

This file was deleted.

79 changes: 79 additions & 0 deletions notebooks/onwards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# 🏔 Onwards
Notes about what currently breaks 💥 and what could be better tomorrow.
- [x] Lists spacing is broken
- [x] Nested lists are not formatted correctly
- [x] Errors are global, but should be local
- [x] Printing a var
- [x] Switch to fast serialization using Nippy
- [x] Store results as CAS files, only write when needed
- [x] Don't thaw result if it's already in memory
- [x] Don't cache things that are fast to evaluate
- [x] Handle conditional read in cljc files
- [x] Add README
- [x] Markdown should support Nextjournal Flavored Markdown including:
- [x] TODO lists 😹
- [x] Inline Formulas $E^2=m^2+\vec{p}^2$
- [x] Fix analyzer error for aliases requires w/o ns (e.g. in viewers notebooks)
## 🕵🏻‍♀️ Viewers
- [x] Make viewer api open with predicates
- [x] Make viewer registration local on namespace
- [x] Make js-only viewers like plotly & vega work
- [x] Fix maps
- [x] Sort maps
- [x] Lazy seqs
- [x] Fix Rule 30 maps
- [x] Drop vector brackets when lazy load map element
- [x] Review viewer registration api
- [x] Simplify viewer api (drop `view-as` & change argument order in `with-viewer`/`s`)
- [x] Fix seeing map with blob-id in Rule 30 notebook
- [x] Turn `with-viewers` into a macro and make it take same unquoted form as `set-viewers!`
- [x] Consistently use `Fn+Form` to carry viewer functions
- [x] Make map-viewer pass down options to select map-entry renderer for children and remove viewer from Rule 30
- [x] Drop lazy loading attempts in plotly + vega viewers
- [x] Keep expanded state when lazy loading
- [x] Move update opts fn to viewer map
- [x] Restrict string length + enable lazy loading
- [x] Let the viewer opt into pagination
- [x] A browser refresh is currently needed to reset a viewer override like in `notebooks/rule_30.clj`, otherwise it will carry over the viewer override to other notebooks that do no specify an override
- [x] Evaluation error messages are poorly formatted
- [x] `first-generation` in `notebooks/rule_30.clj` renders incorrectly because of pagination type coercion from vector to list
- [x] `(def r (range 100))` in `notebooks/pagination.clj` shows incorrect `count`
- [x] Printing of very large values
### 👁 More Viewers
- [ ] Binary / Hex
- [x] Image
## 🚀 Private Beta
- [x] Move to non-jit compiled tailwind stylesheet, purging doesn't work nicely with custom viewers
- [x] Make static build work
- [x] Review caching api
- [x] Change `:clerk/no-cache` to `:nextjournal.clerk/no-cache`
- [x] Move public viewer api to `nextjournal.clerk` and use `(:require [nextjournal.clerk :as clerk])` in all example notebooks
## 💒 Open Source Release
- [x] Allow to pin notebook
- [x] Release to maven & invite contributors
- [x] Fix error when describing Datomic entities
- [x] Limit description to make large datasets work
- [x] Debug & fix extra calls to inspect / rendering
- [x] Setup up static builds
- [x] Fix [link](#) style when code cell uses markdown viewer
- [x] Do pass over README
- [x] Add CHANGELOG
- [x] Release 0.2
- [x] Make github repo public
## 🛠 Up Next
- [x] Let consumers (SICMUitls) extend sci ns by putting it into an atom
- [x] Support setting `:nextjournal.clerk/no-cache` on namespaces as well
- [ ] Support setting `:nextjournal.clerk/cache-dir` on namespace
- [ ] Allow to control viewer expansion state programmatically
- [x] Datafy or Metadata viewer via `:transform-fn`
- [x] Persist viewer expansion state across reloads
- [ ] Show eval error in overlay to persist scroll state when it disappears
- [ ] Improve feedback when viewer errors
- [ ] Support evaluating `(quote 'code 'in 'backticks)` in markdown
- [ ] Make stacktraces clickable
- [x] Build static build on CI
- [x] Hook up new table viewer
- [ ] Add CAS storage option for static builds
## 💡 Ideas
- [ ] Hook up distributed caching using CAS + cloud bucket
- [ ] Status log
6 changes: 3 additions & 3 deletions src/nextjournal/clerk.clj
Original file line number Diff line number Diff line change
Expand Up @@ -267,11 +267,11 @@
;; static builds

(def clerk-docs
(into ["notebooks/markdown.md"]
(into ["notebooks/markdown.md"
"notebooks/onwards.md"]
(map #(str "notebooks/" % ".clj"))
["hello"
"how_clerk_works"
"onwards"
"pagination"
"paren_soup"
#_"readme" ;; TODO: add back when we have Clojure cells in md
Expand Down Expand Up @@ -315,7 +315,7 @@

(show! "notebooks/rule_30.clj")
(show! "notebooks/viewer_api.clj")
(show! "notebooks/onwards.clj")
(show! "notebooks/onwards.md")
(show! "notebooks/pagination.clj")
(show! "notebooks/how_clerk_works.clj")
(show! "notebooks/conditional_read.cljc")
Expand Down

0 comments on commit 8979ce7

Please sign in to comment.