Reorganize AI docs

Move them into the appropriate sections in the new docs structure.
geldata · Feb 21, 2025 · 7ce610a · 7ce610a
1 parent 220830b
commit 7ce610a
Show file tree

Hide file tree

Showing 15 changed files with 79 additions and 48 deletions.
diff --git a/docs/ai/reference_extai.rst → docs/ai/extai.rst b/docs/ai/reference_extai.rst → docs/ai/extai.rst
diff --git a/docs/ai/reference_http.rst → docs/ai/http.rst b/docs/ai/reference_http.rst → docs/ai/http.rst
@@ -1,10 +1,8 @@
 .. _ref_ai_http_reference:
 
-=====================
-AI HTTP API Reference
-=====================
-
-:edb-alt-title: AI Extension HTTP API
+========
+HTTP API
+========
 
 .. note::
 
@@ -48,9 +46,9 @@ Example request
 
 .. code-block:: bash
 
-    curl --user <username>:<password> --json '{
-      "input": "What color is the sky on Mars?",
-      "model": "text-embedding-3-small"
+  $ curl --user <username>:<password> --json '{\
+      "input": "What color is the sky on Mars?",\
+      "model": "text-embedding-3-small"\
     }' http://localhost:10931/branch/main/ai/embeddings
 
 
@@ -162,12 +160,12 @@ Request body
 Example request
 ---------------
 
-.. code-block::
+.. code-block:: bash
 
-    curl --user <username>:<password> --json '{
-      "query": "What color is the sky on Mars?",
-      "model": "gpt-4-turbo-preview",
-      "context": {"query":"Knowledge"}
+  $ curl --user <username>:<password> --json '{\
+      "query": "What color is the sky on Mars?",\
+      "model": "gpt-4-turbo-preview",\
+      "context": {"query":"Knowledge"}\
     }' http://<gel-host>:<port>/branch/main/ai/rag
 
 

diff --git a/docs/ai/index.rst b/docs/ai/index.rst
@@ -8,14 +8,10 @@ Gel AI
     :hidden:
     :maxdepth: 3
 
-    quickstart_fastapi_ai
-    reference_extai
-    reference_http
-    reference_python
+    extai
+    http
+    python
     javascript
-    guide_edgeql
-    guide_python
-    fastapi_gelai_searchbot
 
 :edb-alt-title: Using Gel AI
 

diff --git a/docs/ai/javascript.rst b/docs/ai/javascript.rst
@@ -1,20 +1,29 @@
 .. _ref_ai_javascript:
 
-==========
-JavaScript
-==========
-
-:edb-alt-title: Gel AI's JavaScript package
+==============
+JavaScript API
+==============
 
 ``@gel/ai`` offers a convenient wrapper around ``ext::ai``. Install it with
 npm or via your package manager of choice:
 
-.. code-block:: bash
+.. tabs::
+
+    .. code-tab:: bash
+
+        $ npm install @gel/ai
+
+    .. code-tab:: bash
+
+        $ yarn add @gel/ai
+
+    .. code-tab:: bash
+
+        $ pnpm add @gel/ai
+
+    .. code-tab:: bash
 
-    $ npm install @gel/ai # or
-    $ yarn add @gel/ai # or
-    $ pnpm add @gel/ai # or
-    $ bun add @gel/ai
+        $ bun add @gel/ai
 
 
 Usage

diff --git a/docs/ai/reference_python.rst → docs/ai/python.rst b/docs/ai/reference_python.rst → docs/ai/python.rst
@@ -1,10 +1,8 @@
 .. _ref_ai_python_reference:
 
-=============
-AI Python API
-=============
-
-:edb-alt-title: AI Extension Python API
+==========
+Python API
+==========
 
 The ``gel.ai`` package is an optional binding of the AI extension in |Gel|.
 

diff --git a/docs/ai/guide_edgeql.rst → docs/intro/guides/ai_edgeql.rst b/docs/ai/guide_edgeql.rst → docs/intro/guides/ai_edgeql.rst
@@ -1,8 +1,8 @@
 .. _ref_ai_guide_edgeql:
 
-=========================
-Guide to Gel AI in EdgeQL
-=========================
+================
+Gel AI in EdgeQL
+================
 
 :edb-alt-title: How to set up Gel AI in EdgeQL
 

diff --git a/docs/ai/guide_python.rst → docs/intro/guides/ai_python.rst b/docs/ai/guide_python.rst → docs/intro/guides/ai_python.rst
@@ -1,8 +1,8 @@
 .. _ref_ai_guide_python:
 
-=========================
-Guide to Gel AI in Python
-=========================
+================
+Gel AI in Python
+================
 
 :edb-alt-title: How to set up Gel AI in Python
 

diff --git a/docs/intro/guides/index.rst b/docs/intro/guides/index.rst
@@ -0,0 +1,9 @@
+======
+Guides
+======
+
+.. toctree::
+  :maxdepth: 1
+
+  ai_edgeql
+  ai_python
diff --git a/docs/intro/index.rst b/docs/intro/index.rst
@@ -8,6 +8,8 @@ Get Started
     :hidden:
 
     quickstart/index
+    tutorials/index
+    guides/index
     cli
     instances
     projects

diff --git a/docs/ai/quickstart_fastapi_ai.rst → docs/intro/quickstart/ai/fastapi.rst b/docs/ai/quickstart_fastapi_ai.rst → docs/intro/quickstart/ai/fastapi.rst
diff --git a/docs/intro/quickstart/ai/index.rst b/docs/intro/quickstart/ai/index.rst
@@ -0,0 +1,10 @@
+.. edb:env-switcher::
+
+=========
+Adding AI
+=========
+
+.. toctree::
+  :maxdepth: 1
+
+  fastapi
diff --git a/docs/intro/quickstart/index.rst b/docs/intro/quickstart/index.rst
@@ -11,4 +11,5 @@ Quickstart
   modeling/index
   connecting/index
   working/index
-  inheritance/index
+  inheritance/index
+  ai/index
diff --git a/docs/intro/quickstart/overview/index.rst b/docs/intro/quickstart/overview/index.rst
@@ -1,8 +1,8 @@
 .. edb:env-switcher::
 
-==========
-Quickstart
-==========
+========
+Overview
+========
 
 .. toctree::
   :maxdepth: 3

diff --git a/docs/ai/fastapi_gelai_searchbot.rst → .../intro/tutorials/ai_fastapi_searchbot.rst b/docs/ai/fastapi_gelai_searchbot.rst → .../intro/tutorials/ai_fastapi_searchbot.rst
@@ -1,8 +1,8 @@
 .. _ref_guide_fastapi_gelai_searchbot:
 
-===================
-FastAPI (Searchbot)
-===================
+===============================
+Build a Search Bot with FastAPI
+===============================
 
 :edb-alt-title: Building a search bot with memory using FastAPI and Gel AI
 

diff --git a/docs/intro/tutorials/index.rst b/docs/intro/tutorials/index.rst
@@ -0,0 +1,8 @@
+=========
+Tutorials
+=========
+
+.. toctree::
+  :maxdepth: 2
+
+  ai_fastapi_searchbot