docs: change REAME.adoc

zhenyuanlau · Jun 1, 2024 · 6999edf · 6999edf
1 parent 1565d37
commit 6999edf
Show file tree

Hide file tree

Showing 6 changed files with 166 additions and 53 deletions.
diff --git a/Brewfile b/Brewfile
@@ -1,5 +1,4 @@
 brew "node"
 brew "kcat"
-
-cask "orbstack"
-cask "ollama"
+brew "watchexec"
+brew "[email protected]"
diff --git a/Brewfile.lock.json b/Brewfile.lock.json
@@ -1,20 +1,50 @@
 {
   "entries": {
-    "cask": {
-      "orbstack": {
-        "version": "1.5.1_16857",
-        "options": {
-          "full_name": "orbstack"
+    "brew": {
+      "node": {
+        "version": "22.2.0",
+        "bottle": {
+          "rebuild": 0,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_sonoma": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/node/blobs/sha256:e5136cf5f60e0dec5911e8f7bcf6a17909a2d043aa0203144a2c6d7431f74b3e",
+              "sha256": "e5136cf5f60e0dec5911e8f7bcf6a17909a2d043aa0203144a2c6d7431f74b3e"
+            },
+            "arm64_ventura": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/node/blobs/sha256:eda5dd987bc37b8ec31e06e34f3ffa574cdf3a2930e08476f64d8a3b17faf848",
+              "sha256": "eda5dd987bc37b8ec31e06e34f3ffa574cdf3a2930e08476f64d8a3b17faf848"
+            },
+            "arm64_monterey": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/node/blobs/sha256:6999c3139fbfa0b8937f6a0793b51e9e1206ab2841a4c676b63b33875871f9a5",
+              "sha256": "6999c3139fbfa0b8937f6a0793b51e9e1206ab2841a4c676b63b33875871f9a5"
+            },
+            "sonoma": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/node/blobs/sha256:1550bb353d43877f3df0a302fa6be5e08df0dcab4b5933a0d2335eb622ca4985",
+              "sha256": "1550bb353d43877f3df0a302fa6be5e08df0dcab4b5933a0d2335eb622ca4985"
+            },
+            "ventura": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/node/blobs/sha256:cc3adc9f16f74cad21df1b2a7b975aadf6d9f3c58d7cbd1b9cb079b8eea107cb",
+              "sha256": "cc3adc9f16f74cad21df1b2a7b975aadf6d9f3c58d7cbd1b9cb079b8eea107cb"
+            },
+            "monterey": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/node/blobs/sha256:0f3aac142a02f3e01908aa8faa47920230258cae2bfb0d4a0c407e27a855e263",
+              "sha256": "0f3aac142a02f3e01908aa8faa47920230258cae2bfb0d4a0c407e27a855e263"
+            },
+            "x86_64_linux": {
+              "cellar": "/home/linuxbrew/.linuxbrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/node/blobs/sha256:b2c52dfd4670e09e7604af698efdd254e1bd085baac6f16737491f6eacd3bb75",
+              "sha256": "b2c52dfd4670e09e7604af698efdd254e1bd085baac6f16737491f6eacd3bb75"
+            }
+          }
         }
       },
-      "ollama": {
-        "version": "0.1.38",
-        "options": {
-          "full_name": "ollama"
-        }
-      }
-    },
-    "brew": {
       "kcat": {
         "version": "1.7.0",
         "bottle": {
@@ -78,13 +108,101 @@
             }
           }
         }
+      },
+      "watchexec": {
+        "version": "2.1.1",
+        "bottle": {
+          "rebuild": 0,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_sonoma": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/watchexec/blobs/sha256:d49c46a24643a95b15f96d4f4edaed0987a7cea2f7c1b67ceb6c7288eda434c4",
+              "sha256": "d49c46a24643a95b15f96d4f4edaed0987a7cea2f7c1b67ceb6c7288eda434c4"
+            },
+            "arm64_ventura": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/watchexec/blobs/sha256:b119db8feff4390a416dca3cdab129da3818cf8749e3b54b71045828946d6c3a",
+              "sha256": "b119db8feff4390a416dca3cdab129da3818cf8749e3b54b71045828946d6c3a"
+            },
+            "arm64_monterey": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/watchexec/blobs/sha256:f673c4b9147c07fef4cc025c7d7fb6c77faf9617978b8513b7ca71274de62ae9",
+              "sha256": "f673c4b9147c07fef4cc025c7d7fb6c77faf9617978b8513b7ca71274de62ae9"
+            },
+            "sonoma": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/watchexec/blobs/sha256:5b8148e46cab6456a73efd4b00dd0022fa06a9658287468625a371a087e8f446",
+              "sha256": "5b8148e46cab6456a73efd4b00dd0022fa06a9658287468625a371a087e8f446"
+            },
+            "ventura": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/watchexec/blobs/sha256:845868fc2a11625b1c5ab16f3707f8eb95de9466a3e18925c852633c98883dd3",
+              "sha256": "845868fc2a11625b1c5ab16f3707f8eb95de9466a3e18925c852633c98883dd3"
+            },
+            "monterey": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/watchexec/blobs/sha256:f73117d7374dc6db7738d248fb3993886a94a4c8afd38391eec5d9bf9f6c9a48",
+              "sha256": "f73117d7374dc6db7738d248fb3993886a94a4c8afd38391eec5d9bf9f6c9a48"
+            },
+            "x86_64_linux": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/watchexec/blobs/sha256:cfb5474ab4d255d609eadb4684ce4db5c9729954884bc9b7f11fea6fab539f9b",
+              "sha256": "cfb5474ab4d255d609eadb4684ce4db5c9729954884bc9b7f11fea6fab539f9b"
+            }
+          }
+        }
+      },
+      "[email protected]": {
+        "version": "3.10.14",
+        "bottle": {
+          "rebuild": 0,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_sonoma": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/python/3.10/blobs/sha256:4068f5e2e1370502de8fcf54e43f7aeaf825fea72d1d69e34c54ba4b7ac714a4",
+              "sha256": "4068f5e2e1370502de8fcf54e43f7aeaf825fea72d1d69e34c54ba4b7ac714a4"
+            },
+            "arm64_ventura": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/python/3.10/blobs/sha256:8794c74617118d900893131cf49eb695d75063275890e03070252e4fce9c778e",
+              "sha256": "8794c74617118d900893131cf49eb695d75063275890e03070252e4fce9c778e"
+            },
+            "arm64_monterey": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/python/3.10/blobs/sha256:73fb11a2a2008bb85d82f005e0ee5417a5dff3d6c6b88a12a93ced81d960fc22",
+              "sha256": "73fb11a2a2008bb85d82f005e0ee5417a5dff3d6c6b88a12a93ced81d960fc22"
+            },
+            "sonoma": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/python/3.10/blobs/sha256:59d79d661030f9523dfca8262e98a361d019174421ee34a7486734898d29692e",
+              "sha256": "59d79d661030f9523dfca8262e98a361d019174421ee34a7486734898d29692e"
+            },
+            "ventura": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/python/3.10/blobs/sha256:5210a41b8515b802031c14792d1892a6a9a6c8ca3f35f3e840742a58410710b0",
+              "sha256": "5210a41b8515b802031c14792d1892a6a9a6c8ca3f35f3e840742a58410710b0"
+            },
+            "monterey": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/python/3.10/blobs/sha256:3c6fb32876dff5afb7deb024d84e0344d4b8d599bb310b470b9cf7d90fad7a1c",
+              "sha256": "3c6fb32876dff5afb7deb024d84e0344d4b8d599bb310b470b9cf7d90fad7a1c"
+            },
+            "x86_64_linux": {
+              "cellar": "/home/linuxbrew/.linuxbrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/python/3.10/blobs/sha256:080fe880a66b737f7131bac5ab4ccaf2e3498e87efefa9e4062424bc8aa5d969",
+              "sha256": "080fe880a66b737f7131bac5ab4ccaf2e3498e87efefa9e4062424bc8aa5d969"
+            }
+          }
+        }
       }
     }
   },
   "system": {
     "macos": {
       "sonoma": {
-        "HOMEBREW_VERSION": "4.3.0",
+        "HOMEBREW_VERSION": "4.3.2",
         "HOMEBREW_PREFIX": "/opt/homebrew",
         "Homebrew/homebrew-core": "api",
         "CLT": "15.3.0.0.1.1708646388",

diff --git a/Makefile b/Makefile
@@ -48,14 +48,11 @@ ollama.llm: ollama.llama3 ollama.dolphincoder
 jupyter.lab:
 	$(PY) -m jupyter lab --NotebookApp.notebook_dir=./notebooks
 
-docs: clean
-	@npx -p antora -p asciidoctor-kroki -c 'antora antora-playbook.yml'
+livebook.open:
+	@open http://127.0.0.1:8080/
 
-docs.server: docs
-	@npx http-server build/site -c-1
-
-open:
+litellm.ui:
 	@open http://127.0.0.1:4444/ui
 
-clean:
-	@rm -fr build/site
+antora:
+	@watchexec -w docs -- npx -p antora -p asciidoctor-kroki -c \'antora antora-playbook.yml\'
diff --git a/README.adoc b/README.adoc
@@ -6,33 +6,14 @@ A new homeland for developing AI-native applications.
 
 link:https://zhenyuanlau.github.io/neoland/neoland/index.html[Neoland GitHub Pages].
 
-== Stack
+== Make
 
 [source, shell]
 
 ------
 git clone https://github.com/zhenyuanlau/neoland.git
 
 cd neoland
-------
-
-=== Setup
-
-[source, shell]
 
-----
 make
-
-make ollama.llama3
-
-make ollama.dolphincoder
-----
-
-=== Play
-
-[source, shell]
-------
-make open
-
-# user/password: llm/llm
 ------
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -11,11 +11,18 @@ AI First!
 |===
 |Source| Item
 
-|link:https://brew.sh/[Homebrew]
+|Official
 a|
+
 * link:https://orbstack.dev/[Orbstack]
 * link:https://ollama.ai/[Ollama]
-* link:https://docs.confluent.io/platform/current/tools/kafkacat-usage.html[kcat]
+* link:https://chatboxai.app/[Chatbox]
+
+|link:https://brew.sh/[Homebrew]
+a|
+
+* https://nodejs.org/en/download/package-manager[Node]
+* link:https://www.python.org/downloads/[Python 3.10.X]
 
 |link:https://orbstack.dev/[Orbstack]
 a|
@@ -32,6 +39,7 @@ a|
 * link:https://docs.ansible.com/ansible-core/devel/getting_started/index.html[Ansible]
 * link:https://jupyter.org/install[Jupyter Lab]
 
+
 |===
 
 == Infrastructure
@@ -47,26 +55,30 @@ image::land-on-orbstack.png[]
 |make
 |Setup neoland on Orbstack
 
-|make docs 
-|Antora site generation and show index.html file
-
-|make open
+|make litellm.ui
 |Open LiteLLM UI page in browser
 
 |make ollama.llm
-a|Pull ollama language model
+a|Pull ollama language models, include:
 
 * llama3
 * dolphincoder
 
+|make jupyter.lab
+|Run jupyter lab
+
+|make livebook.open
+|Open livebook
+
 |make <component>
 a| Recreate neoland components, include:
 
 * redis
+* kafka 
 * postgres
 * rabbitmq
-* kafka 
 * clickhouse
 * litellm
+* livebook
 
 |===
diff --git a/docs/modules/ai/pages/llm/litellm.adoc b/docs/modules/ai/pages/llm/litellm.adoc
@@ -18,3 +18,9 @@ pip install 'litellm[proxy]'
 litellm --model ollama_chat/llama3
 ----
 
+== LiteLLM UI
+
+[source, shell]
+------
+make litellm.ui
+------