tim-smart · jfarid27 · Jun 7, 2026 · Jun 7, 2026 · Jun 7, 2026 · Jun 8, 2026
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,10 @@ dist/
 .direnv/
 .idea/
 packages/*/docs
+
+## Jekyll Docs
+docs/vendor
+docs/_site
+docs/.bundle
+docs/Gemfile.lock
+
diff --git a/README.md b/README.md
@@ -586,3 +586,30 @@ class MyService extends Effect.Service<MyService>()("MyService", {
   })
 }) {}
 ```
+
+
+# Documentation
+
+## Installation
+
+Docs are generated with docgen, and require jekyll to be run locally:
+
+Ensure jekyll and bundler is avaliable on your system. First, run
+```bash
+gem install bundler jekyll
+```
+
+or to install this in the gem user space:
+
+```bash
+gem install bundler jekyll --user-install
+```
+
+Next, navigate to the docs directory at `docs/` and run:
+
+```bash
+bundle install
+bundle exec jekyll serve --livereload
+```
+
+The docs will be available at `http://localhost:4000`.
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gem "github-pages", group: :jekyll_plugins
+gem "just-the-docs"
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -2,8 +2,8 @@ remote_theme: mikearnaldi/just-the-docs
 search_enabled: true
 aux_links:
   "Docs":
-    - "//tim-smart.github.io/effect-rx"
+    - "//tim-smart.github.io/effect-atom"
   "API Reference":
-    - "//tim-smart.github.io/effect-rx/docs/rx"
+    - "//tim-smart.github.io/effect-atom/docs/atom"
   "GitHub":
-    - "//github.com/tim-smart/effect-rx"
+    - "//github.com/tim-smart/effect-atom"
diff --git a/docs/atom-livestore/AtomLivestore.ts.md b/docs/atom-livestore/AtomLivestore.ts.md
@@ -2,6 +2,7 @@
 title: AtomLivestore.ts
 nav_order: 1
 parent: "@effect-atom/atom-livestore"
+grand_parent: "Reference"
 ---
 
 ## AtomLivestore overview

diff --git a/docs/atom-livestore/index.md b/docs/atom-livestore/index.md
@@ -2,5 +2,6 @@
 title: "@effect-atom/atom-livestore"
 has_children: true
 permalink: /docs/atom-livestore
-nav_order: 3
+nav_order: 2
+parent: "Reference"
 ---
diff --git a/docs/atom-livestore/index.ts.md b/docs/atom-livestore/index.ts.md
@@ -2,6 +2,7 @@
 title: index.ts
 nav_order: 2
 parent: "@effect-atom/atom-livestore"
+grand_parent: "Reference"
 ---
 
 ## index overview

diff --git a/docs/atom-react/Hooks.ts.md b/docs/atom-react/Hooks.ts.md
@@ -2,6 +2,7 @@
 title: Hooks.ts
 nav_order: 1
 parent: "@effect-atom/atom-react"
+grand_parent: "Reference"
 ---
 
 ## Hooks overview

diff --git a/docs/atom-react/ReactHydration.ts.md b/docs/atom-react/ReactHydration.ts.md
@@ -2,6 +2,7 @@
 title: ReactHydration.ts
 nav_order: 3
 parent: "@effect-atom/atom-react"
+grand_parent: "Reference"
 ---
 
 ## ReactHydration overview

diff --git a/docs/atom-react/RegistryContext.ts.md b/docs/atom-react/RegistryContext.ts.md
@@ -2,6 +2,7 @@
 title: RegistryContext.ts
 nav_order: 4
 parent: "@effect-atom/atom-react"
+grand_parent: "Reference"
 ---
 
 ## RegistryContext overview

diff --git a/docs/atom-react/ScopedAtom.ts.md b/docs/atom-react/ScopedAtom.ts.md
@@ -2,6 +2,7 @@
 title: ScopedAtom.ts
 nav_order: 5
 parent: "@effect-atom/atom-react"
+grand_parent: "Reference"
 ---
 
 ## ScopedAtom overview

diff --git a/docs/atom-react/index.md b/docs/atom-react/index.md
@@ -2,5 +2,6 @@
 title: "@effect-atom/atom-react"
 has_children: true
 permalink: /docs/atom-react
-nav_order: 4
+nav_order: 3
+parent: "Reference"
 ---
diff --git a/docs/atom-react/index.ts.md b/docs/atom-react/index.ts.md
@@ -2,6 +2,7 @@
 title: index.ts
 nav_order: 2
 parent: "@effect-atom/atom-react"
+grand_parent: "Reference"
 ---
 
 ## index overview

diff --git a/docs/atom-solid/Hooks.ts.md b/docs/atom-solid/Hooks.ts.md
@@ -2,6 +2,7 @@
 title: Hooks.ts
 nav_order: 1
 parent: "@effect-atom/atom-solid"
+grand_parent: "Reference"
 ---
 
 ## Hooks overview

diff --git a/docs/atom-solid/RegistryContext.ts.md b/docs/atom-solid/RegistryContext.ts.md
@@ -2,6 +2,7 @@
 title: RegistryContext.ts
 nav_order: 3
 parent: "@effect-atom/atom-solid"
+grand_parent: "Reference"
 ---
 
 ## RegistryContext overview

diff --git a/docs/atom-solid/index.md b/docs/atom-solid/index.md
@@ -2,5 +2,6 @@
 title: "@effect-atom/atom-solid"
 has_children: true
 permalink: /docs/atom-solid
-nav_order: 5
+nav_order: 4
+parent: "Reference"
 ---
diff --git a/docs/atom-solid/index.ts.md b/docs/atom-solid/index.ts.md
@@ -2,6 +2,7 @@
 title: index.ts
 nav_order: 2
 parent: "@effect-atom/atom-solid"
+grand_parent: "Reference"
 ---
 
 ## index overview

diff --git a/docs/atom-vue/index.md b/docs/atom-vue/index.md
@@ -2,5 +2,6 @@
 title: "@effect-atom/atom-vue"
 has_children: true
 permalink: /docs/atom-vue
-nav_order: 6
+nav_order: 5
+parent: "Reference"
 ---
diff --git a/docs/atom-vue/index.ts.md b/docs/atom-vue/index.ts.md
@@ -2,6 +2,7 @@
 title: index.ts
 nav_order: 1
 parent: "@effect-atom/atom-vue"
+grand_parent: "Reference"
 ---
 
 ## index overview

diff --git a/docs/atom/Atom.ts.md b/docs/atom/Atom.ts.md
@@ -2,6 +2,7 @@
 title: Atom.ts
 nav_order: 1
 parent: "@effect-atom/atom"
+grand_parent: "Reference"
 ---
 
 ## Atom overview

diff --git a/docs/atom/AtomHttpApi.ts.md b/docs/atom/AtomHttpApi.ts.md
@@ -2,6 +2,7 @@
 title: AtomHttpApi.ts
 nav_order: 2
 parent: "@effect-atom/atom"
+grand_parent: "Reference"
 ---
 
 ## AtomHttpApi overview

diff --git a/docs/atom/AtomRef.ts.md b/docs/atom/AtomRef.ts.md
@@ -2,6 +2,7 @@
 title: AtomRef.ts
 nav_order: 3
 parent: "@effect-atom/atom"
+grand_parent: "Reference"
 ---
 
 ## AtomRef overview

diff --git a/docs/atom/AtomRpc.ts.md b/docs/atom/AtomRpc.ts.md
@@ -2,6 +2,7 @@
 title: AtomRpc.ts
 nav_order: 4
 parent: "@effect-atom/atom"
+grand_parent: "Reference"
 ---
 
 ## AtomRpc overview

diff --git a/docs/atom/Hydration.ts.md b/docs/atom/Hydration.ts.md
@@ -2,6 +2,7 @@
 title: Hydration.ts
 nav_order: 5
 parent: "@effect-atom/atom"
+grand_parent: "Reference"
 ---
 
 ## Hydration overview

diff --git a/docs/atom/Registry.ts.md b/docs/atom/Registry.ts.md
@@ -2,6 +2,7 @@
 title: Registry.ts
 nav_order: 7
 parent: "@effect-atom/atom"
+grand_parent: "Reference"
 ---
 
 ## Registry overview

diff --git a/docs/atom/Result.ts.md b/docs/atom/Result.ts.md
@@ -2,6 +2,7 @@
 title: Result.ts
 nav_order: 8
 parent: "@effect-atom/atom"
+grand_parent: "Reference"
 ---
 
 ## Result overview

diff --git a/docs/atom/index.md b/docs/atom/index.md
@@ -2,5 +2,6 @@
 title: "@effect-atom/atom"
 has_children: true
 permalink: /docs/atom
-nav_order: 2
+nav_order: 1
+parent: "Reference"
 ---
diff --git a/docs/atom/index.ts.md b/docs/atom/index.ts.md
@@ -2,6 +2,7 @@
 title: index.ts
 nav_order: 6
 parent: "@effect-atom/atom"
+grand_parent: "Reference"
 ---
 
 ## index overview