docs: clarify draft status

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
scikit-hep · Oct 17, 2023 · 7f57b18 · 7f57b18
1 parent 4fd4bb0
commit 7f57b18
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -48,6 +48,10 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+myst_enable_extensions = [
+    "colon_fence",
+]
+
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/docs/serialization.md b/docs/serialization.md
@@ -1,5 +1,11 @@
 # Serialization
 
+:::{warning}
+
+Serialization is in draft currently. Once at least one implementation is ready,
+we will remove this warning and release UHI 0.5.
+
+:::
 
 ## Introduction
 

diff --git a/src/uhi/resources/histogram.json → src/uhi/resources/histogram.schema.json b/src/uhi/resources/histogram.json → src/uhi/resources/histogram.schema.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/scikit-hep/uhi/henryiii/feat/schema/src/uhi/resources/histogram.json",
+  "$id": "https://raw.githubusercontent.com/scikit-hep/uhi/main/src/uhi/resources/histogram.schema.json",
   "title": "Histogram",
   "type": "object",
   "additionalProperties": false,