Update documentation + tests (#15)

svilupp · Apr 18, 2024 · 0a166b3 · 0a166b3
1 parent c9e72cd
commit 0a166b3
Show file tree

Hide file tree

Showing 7,128 changed files with 1,248,526 additions and 236 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,7 @@
 /docs/build/
 
 **/.DS_Store
-**/.vscode
+**/.vscode
+
+# exclude scratch files
+**/_*
diff --git a/Artifacts.toml b/Artifacts.toml
@@ -52,4 +52,52 @@ lazy = true
 
     [["makie__textembedding3large-1024-Bool".download]]
     sha256 = "135f36effc0d29ed20e9bc877f727e4d9d8366bcae4bf4d13f998529d1091324"
-    url = "https://github.com/svilupp/AIHelpMeArtifacts/raw/main/artifacts/makie__v20240330__textembedding3large-1024-Bool__v1.0.tar.gz"
+    url = "https://github.com/svilupp/AIHelpMeArtifacts/raw/main/artifacts/makie__v20240330__textembedding3large-1024-Bool__v1.0.tar.gz"
+
+["julia__nomicembedtext-0-Float32"]
+git-tree-sha1 = "cb1fc89392710d729cb031701353fcf58c901fc4"
+lazy = true
+
+    [["julia__nomicembedtext-0-Float32".download]]
+    sha256 = "5bb4507db346903cc8defc395939a2b18ce035e003e1e9ab12104228d6551303"
+    url = "https://github.com/svilupp/AIHelpMeArtifacts/raw/main/artifacts/julia__v1.10.2__nomicembedtext-0-Float32__v1.0.tar.gz"
+
+["julia__nomicembedtext-0-Bool"]
+git-tree-sha1 = "8ef454a8c6990ce8baa0634196826600622c5364"
+lazy = true
+
+    [["julia__nomicembedtext-0-Bool".download]]
+    sha256 = "e0a65288bc868fc0f1a91622317b3f25d0a2bf77f68c049c42e2b90d2ac3e01d"
+    url = "https://github.com/svilupp/AIHelpMeArtifacts/raw/main/artifacts/julia__v1.10.2__nomicembedtext-0-Bool__v1.0.tar.gz"
+
+["tidier__nomicembedtext-0-Float32"]
+git-tree-sha1 = "0bb2e5865246462990d440dc8f75237e31ebfb64"
+lazy = true
+
+    [["tidier__nomicembedtext-0-Float32".download]]
+    sha256 = "6ff921c514faeb2b8ab0250ba28bc5ba5f7007a4f2c77cb9e280ee4ddb7fafee"
+    url = "https://github.com/svilupp/AIHelpMeArtifacts/raw/main/artifacts/tidier__v20240407__nomicembedtext-0-Float32__v1.0.tar.gz"
+
+["tidier__nomicembedtext-0-Bool"]
+git-tree-sha1 = "fc6b3eeca2e11d459ba5aaebfcc10f65fdc07102"
+lazy = true
+
+    [["tidier__nomicembedtext-0-Bool".download]]
+    sha256 = "b3f604f382a7191c657c77017e9d3e455e6eacc1fa6a59e6202e8a83498d4269"
+    url = "https://github.com/svilupp/AIHelpMeArtifacts/raw/main/artifacts/tidier__v20240407__nomicembedtext-1024-Bool__v1.0.tar.gz"
+
+["makie__nomicembedtext-0-Float32"]
+git-tree-sha1 = "4b0ff243278fcbda1491db94e4082c1050a44d80"
+lazy = true
+
+    [["makie__nomicembedtext-0-Float32".download]]
+    sha256 = "6325497b90a61b4200250d5075d0f6d8ec2453a53f7d18fbcfc6187d3eea2018"
+    url = "https://github.com/svilupp/AIHelpMeArtifacts/raw/main/artifacts/makie__v20240330__nomicembedtext-0-Float32__v1.0.tar.gz"
+
+["makie__nomicembedtext-0-Bool"]
+git-tree-sha1 = "723274bf0cb72d39efbc7b07a1de9e02eccf5ba6"
+lazy = true
+
+    [["makie__nomicembedtext-0-Bool".download]]
+    sha256 = "c62a0d3d27fc417498d2449b59c58d18dba34164094a08206b51e88d05fa7fa7"
+    url = "https://github.com/svilupp/AIHelpMeArtifacts/raw/main/artifacts/makie__v20240330__nomicembedtext-1024-Bool__v1.0.tar.gz"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Bumped up PromptingTools to v0.20 (brings new RAG capabilities, pretty-printing, etc.)
 - Changed default model to be GPT-4 Turbo to improve answer quality
+- Documentation moved to Vitepress
 
 ### Fixed
 - Fixed wrong initiation of `CONV_HISTORY` and other globals that led to UndefVarError. Moved several globals to `const Ref{}` pattern to ensure type stability, but it means that from now it always needs to be dereferenced with `[]` (eg, `MAIN_INDEX[]` instead of `MAIN_INDEX`).

diff --git a/Project.toml b/Project.toml
@@ -18,10 +18,12 @@ SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
 [compat]
 Aqua = "0.7"
+HDF5 = "0.14 - 0.17"
 HTTP = "1"
 JSON3 = "1"
 LazyArtifacts = "<0.0.1, 1"
 LinearAlgebra = "<0.0.1, 1"
+PrecompileTools = "1"
 Preferences = "1"
 PromptingTools = "=0.20.1"
 REPL = "1"

diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ All setup should take less than 5 minutes!
 5. **Debugging**:
    How did you come up with that answer? Check the "context" provided to the AI model (ie, the documentation snippets that were used to generate the answer):
     ```julia
-    AIHelpMe.pprint(AIHelpMe.LAST_RESULT[])
+    AIHelpMe.pprint(AIHelpMe.last_result())
     # Output: Pretty-printed Question + Context + Answer with color highlights
     ```
 
@@ -115,7 +115,7 @@ All setup should take less than 5 minutes!
     You can change the kwargs of `pprint` to hide the annotations or potentially even show the underlying context (snippets from the documentation):
 
     ```julia
-    AIHelpMe.pprint(AIHelpMe.LAST_RESULT[]; add_context = true, add_scores = false)
+    AIHelpMe.pprint(AIHelpMe.last_result(); add_context = true, add_scores = false)
     ```
 
 ## How to Obtain API Keys

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,4 @@
+build/
+node_modules/
+package-lock.json
+Manifest.toml
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,7 @@
 [deps]
 AIHelpMe = "01402e1f-dc83-4213-a98b-42887d758baa"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
+
+[compat]
+DocumenterVitepress = "0.0.7"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,23 +1,38 @@
 using AIHelpMe
-using Documenter
+using Documenter, DocumenterVitepress
 
 DocMeta.setdocmeta!(AIHelpMe, :DocTestSetup, :(using AIHelpMe); recursive = true)
 
 makedocs(;
     modules = [AIHelpMe],
     authors = "J S <[email protected]> and contributors",
+    repo = "https://github.com/svilupp/AIHelpMe.jl/blob/{commit}{path}#{line}",
     sitename = "AIHelpMe.jl",
-    format = Documenter.HTML(;
-        repolink = "https://github.com/svilupp/AIHelpMe.jl",
-        canonical = "https://svilupp.github.io/PromptingTools.jl",
-        edit_link = "main",
-        assets = String[],),
+    ## format = Documenter.HTML(;
+    ##     repolink = "https://github.com/svilupp/AIHelpMe.jl",
+    ##     canonical = "https://svilupp.github.io/AIHelpMe.jl",
+    ##     edit_link = "main",
+    ##     assets = String[]),
+    format = DocumenterVitepress.MarkdownVitepress(
+        repo = "https://github.com/svilupp/AIHelpMe.jl",
+        devbranch = "main",
+        devurl = "dev",
+        deploy_url = "svilupp.github.io/AIHelpMe.jl"
+    ),
+    draft = false,
+    source = "src",
+    build = "build",
     pages = [
         "Home" => "index.md",
+        "Introduction" => "introduction.md",
+        "Advanced" => "advanced.md",
         "F.A.Q" => "faq.md",
-        "Reference" => "reference.md",
-    ],)
+        "Reference" => "reference.md"
+    ])
 
 deploydocs(;
     repo = "github.com/svilupp/AIHelpMe.jl",
-    devbranch = "main",)
+    target = "build",
+    push_preview = true,
+    branch = "gh-pages",
+    devbranch = "main")
diff --git a/docs/node_modules/.bin/acorn b/docs/node_modules/.bin/acorn
diff --git a/docs/node_modules/.bin/esbuild b/docs/node_modules/.bin/esbuild
diff --git a/docs/node_modules/.bin/juice b/docs/node_modules/.bin/juice
diff --git a/docs/node_modules/.bin/markdown-it b/docs/node_modules/.bin/markdown-it
diff --git a/docs/node_modules/.bin/mime b/docs/node_modules/.bin/mime
diff --git a/docs/node_modules/.bin/nanoid b/docs/node_modules/.bin/nanoid
diff --git a/docs/node_modules/.bin/node-which b/docs/node_modules/.bin/node-which
diff --git a/docs/node_modules/.bin/parser b/docs/node_modules/.bin/parser
diff --git a/docs/node_modules/.bin/rollup b/docs/node_modules/.bin/rollup
diff --git a/docs/node_modules/.bin/sre b/docs/node_modules/.bin/sre
diff --git a/docs/node_modules/.bin/vite b/docs/node_modules/.bin/vite
diff --git a/docs/node_modules/.bin/vite-node b/docs/node_modules/.bin/vite-node
diff --git a/docs/node_modules/.bin/vitepress b/docs/node_modules/.bin/vitepress
diff --git a/docs/node_modules/.bin/vitest b/docs/node_modules/.bin/vitest
diff --git a/docs/node_modules/.bin/why-is-node-running b/docs/node_modules/.bin/why-is-node-running