Automated docs

.gitignore

@@ -37,4 +37,6 @@ coverage/
 
 # Temporary files
 *.tmp
-*.swp
+*.swp
+
+docs/build

biome.json

@@ -24,7 +24,7 @@
     }
   },
   "files": {
-    "ignore": ["python", "**/package.json"]
+    "ignore": ["python", "**/package.json", "viewer/package.json"]
   },
   "vcs": {
     "enabled": true,

docs/viewer/introduction.md

@@ -0,0 +1,33 @@
+---
+title: Quick start
+---
+
+
+### Getting started
+
+## Installation
+
+
+```
+npm install @hms-dbmi/vizarr
+```
+
+## Basic Usage
+
+```
+import VizarrViewer from '@hms-dbmi/vizarr'
+
+function App() {
+
+const sources = ["https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.5/idr0062A/6001240_labels.zarr"]
+
+return(
+  <VizarrViewer
+    sources={sources}
+    viewState={viewState}
+/>
+)
+}
+
+
+```

package.json

@@ -11,6 +11,7 @@
     "build:viewer": "pnpm --filter vizarr build",
     "build:roi-selector": "pnpm --filter @biongff/roi-selector build",
     "build:app": "pnpm --filter app build",
+    "build:docs": "pnpm typedoc --plugin typedoc-github-theme",
     "test": "vitest",
     "build": "pnpm build:viewer && pnpm build:roi-selector && pnpm build:app"
   },
@@ -29,6 +30,8 @@
     "@vitejs/plugin-react": "^4.3.4",
     "@vitest/coverage-v8": "4.0.15",
     "semantic-release": "^25.0.2",
+    "typedoc": "^0.28.18",
+    "typedoc-github-theme": "^0.4.0",
     "typescript": "^5.8.2",
     "vite": "^6.2.7",
     "vitest": "^4.0.15"