Start documenting limitations

Fixes #181
djblue · Aug 27, 2023 · af37b6f · af37b6f
1 parent a7de0e9
commit af37b6f
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/doc/cljdoc.edn b/doc/cljdoc.edn
@@ -39,4 +39,5 @@
    ["System Deps" {:file "doc/dev/deps.md"}]
    ["Editor Setup" {:file "doc/dev/editors.md"}]
    ["Dev Tasks" {:file "doc/dev/tasks.md"}]]
-  ["Inspiration" {:file "doc/inspiration.md"}]]}
+  ["Inspiration" {:file "doc/inspiration.md"}]
+  ["Limitations" {:file "doc/limitations.md"}]]}
diff --git a/doc/limitations.md b/doc/limitations.md
@@ -0,0 +1,19 @@
+# Limitations
+
+Since the Portal UI is implemented in ClojureScript, it also adopts some of its
+platform limitations.
+
+## Dates
+
+Dates captured from your host platform are interpreted as `js/Date` in the
+Portal UI. Therefore, as documents by this [ClojureScript issue][date-issue],
+they are potentially interpreted against a different calendar.
+
+## Longs
+
+Since JavaScript doesn't support the full range of numbers provided by longs,
+integers outside of a certain range must be boxed and shipped as string to the
+UI. This precludes them from participating in viewers that expect `js/Number`.
+
+
+[date-issue]: https://github.com/clojure/clojurescript-site/issues/367