Release v2.9.0

.github/workflows/documentation-links.yml

@@ -0,0 +1,23 @@
+# .github/workflows/documentation-links.yml
+
+name: readthedocs/actions
+on:
+  pull_request_target:
+    types:
+      - opened
+    # Execute this action only on PRs that touch
+    # documentation files
+    paths:
+      - "docs/**"
+
+permissions:
+  pull-requests: write
+
+jobs:
+  documentation-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+        # this is the slug from the non-redirected URL (scicomp-docs.readthedocs.io)
+          project-slug: "aind-data-schema"

.gitignore

@@ -144,6 +144,15 @@ notebook/
 ephys_instrument.json
 examples/*.json
 *.json
+!diagram-app/package.json
+!diagram-app/package-lock.json
+!diagram-app/tsconfig.json
+
+# diagram-app (React Flow schema diagram embedded in the docs front page)
+diagram-app/node_modules/
+docs/source/_static/schema-diagram/
 docs/base/models/*
 .github/copilot-instructions.md
 uv.lock
+schema_tree.md
+schema_tree.tex

.readthedocs.yaml

@@ -4,6 +4,14 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.13"
+    nodejs: "20"
+  jobs:
+    # Build the interactive React Flow schema diagram bundle into
+    # docs/source/_static/ before Sphinx runs (the bundle is git-ignored and
+    # regenerated here; the JSON it fetches is generated by conf.py).
+    pre_build:
+      - npm --prefix diagram-app ci
+      - npm --prefix diagram-app run build
 
 python:
   install:

CONTRIBUTING.md

@@ -51,12 +51,21 @@ python src/aind_data_schema/utils/docs/registries_generator.py
 python src/aind_data_schema/utils/docs/doc_generator.py
 ```
 
+The front page embeds an interactive React Flow diagram of the `Metadata` schema (`diagram-app/`). Build its JS/CSS bundle once before building the docs (it's git-ignored and only needs rebuilding when `diagram-app/` changes):
+
+```bash
+npm --prefix diagram-app ci
+npm --prefix diagram-app run build
+```
+
 Then to create the documentation html files, run:
 
 ```bash
 sphinx-build -b html docs/source/ docs/build/html
 ```
 
+This also (re)generates `docs/source/_static/schema-diagram/schema_diagram.json`, the data the diagram reads at runtime, from the current schema classes.
+
 More info on sphinx installation can be found here: https://www.sphinx-doc.org/en/master/usage/installation.html
 
 ### Testing

diagram-app/index.html

@@ -0,0 +1,16 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>aind-data-schema diagram (dev)</title>
+    <style>
+      html, body { margin: 0; height: 100%; font-family: system-ui, sans-serif; }
+    </style>
+  </head>
+  <body>
+    <!-- In the docs this div is injected by a raw-HTML block; here it drives the dev server. -->
+    <div class="rf-schema-diagram" style="height: 100vh"></div>
+    <script type="module" src="/src/main-viewer.tsx"></script>
+  </body>
+</html>