Updated docs and docs landing page (postgresml#1575)

SilasMarvin · web-flow · commit 6f535c278be4 · 2024-07-17T13:04:55.000-07:00
diff --git a/pgml-cms/docs/open-source/korvus/example-apps/rag-with-openai.md b/pgml-cms/docs/open-source/korvus/example-apps/rag-with-openai.md
@@ -1,3 +1,7 @@
+---
+description: An example application performing RAG with Korvus and OpenAI.
+---
+
 # Rag with OpenAI
 
 This example shows how to use third-party LLM providers like OpenAI to perform RAG with Korvus.
diff --git a/pgml-cms/docs/open-source/korvus/example-apps/semantic-search.md b/pgml-cms/docs/open-source/korvus/example-apps/semantic-search.md
@@ -1,3 +1,8 @@
+---
+description: >-
+  An example application built with Korvus to perform Semantic Search.
+---
+
 # Semantic Search
 
 This example demonstrates using the `korvus` SDK to create a collection, add documents, build a pipeline for vector search and make a sample query.
diff --git a/pgml-dashboard/src/api/cms.rs b/pgml-dashboard/src/api/cms.rs
@@ -563,19 +563,19 @@ impl Collection {
                                                             .href(&url.to_string_lossy());
                                                         links.push(parent);
                                                     }
-                                                    _ => error!("unhandled link child: {node:?}"),
+                                                    _ => warn!("unhandled link child: {node:?}"),
                                                 }
                                             }
                                         }
-                                        _ => error!("unhandled paragraph child: {node:?}"),
+                                        _ => warn!("unhandled paragraph child: {node:?}"),
                                     }
                                 }
                             }
-                            _ => error!("unhandled list_item child: {node:?}"),
+                            _ => warn!("unhandled list_item child: {node:?}"),
                         }
                     }
                 }
-                _ => error!("unhandled list child: {node:?}"),
+                _ => warn!("unhandled list child: {node:?}"),
             }
         }
         Ok(links)
diff --git a/pgml-dashboard/src/components/pages/docs/landing_page/mod.rs b/pgml-dashboard/src/components/pages/docs/landing_page/mod.rs
@@ -20,7 +20,7 @@ lazy_static! {
         ("collections", "overview_key"),
         ("pipelines", "climate_mini_split"),
         ("semantic search", "book"),
-        ("semantic search using instructor model", "book"),
+        ("rag with openai", "book"),
         ("postgresml is 8-40x faster than python http microservices", "fit_page"),
         ("scaling to 1 million requests per second", "bolt"),
         ("mindsdb vs postgresml", "arrow_split"),
@@ -42,7 +42,7 @@ lazy_static! {
         .into_iter()
         .map(|s| s.to_owned())
         .collect();
-    static ref TUTORIAL_TARGETS: Vec<String> = Vec::from(["semantic search"])
+    static ref TUTORIAL_TARGETS: Vec<String> = Vec::from(["semantic search", "rag with openai"])
         .into_iter()
         .map(|s| s.to_owned())
         .collect();
@@ -63,7 +63,6 @@ lazy_static! {
 pub struct LandingPage {
     pgml_ai: Vec<DocCard>,
     pgml_ml: Vec<DocCard>,
-    benchmarks: Vec<DocCard>,
     korvus_overview: Vec<DocCard>,
     korvus_tutorials: Vec<DocCard>,
     feature_banner: FeatureBanner,
@@ -80,14 +79,12 @@ impl LandingPage {
     pub async fn parse_sections(mut self, links: Vec<IndexLink>) -> Self {
         let mut children: Vec<IndexLink> = links.clone();
 
-        let mut benchmarks_folder: Vec<IndexLink> = Vec::new();
         let mut extension_folder: Vec<IndexLink> = Vec::new();
         let mut korvus_folder: Vec<IndexLink> = Vec::new();
         while !children.is_empty() {
             let link = children.pop().unwrap();
 
             match link.title.to_lowercase().as_ref() {
-                "benchmarks" => benchmarks_folder = link.children,
                 "pgml" => extension_folder = link.children,
                 "korvus" => korvus_folder = link.children,
                 _ => {
@@ -121,17 +118,11 @@ impl LandingPage {
             out
         };
 
-        let benchmarks = find_targets(benchmarks_folder, &BENCHMARKS_TARGETS);
         let korvus_overview = find_targets(korvus_folder.clone(), &OVERVIEW_TARGETS);
         let korvus_tutorials = find_targets(korvus_folder, &TUTORIAL_TARGETS);
         let pgml_ai = find_targets(extension_folder.clone(), &AI_TARGETS);
         let pgml_ml = find_targets(extension_folder, &ML_TARGETS);
 
-        for item in benchmarks {
-            let card = DocCard::from_index_link(&item).await;
-            self.benchmarks.push(card);
-        }
-
         for item in korvus_overview {
             let card = DocCard::from_index_link(&item).await;
             self.korvus_overview.push(card);
diff --git a/pgml-dashboard/src/components/pages/docs/landing_page/template.html b/pgml-dashboard/src/components/pages/docs/landing_page/template.html
@@ -55,7 +55,7 @@ <h1 class="text-center">PostgresML</br><span class="text-gradient-green">Documen
 
     <div class="mt-5">
       <%- section_title(
-        "<h2>SQL Extension</h2>",
+        "<h2>PGML SQL Extension</h2>",
         "The SQL extension provides end-to-end ML & AI functionality from inference to deployment. It can be used in any combination to implement bespoke models across use cases.") %>
       
       <div class="d-flex flex-column gap-4_5">
@@ -76,13 +76,13 @@ <h1 class="text-center">PostgresML</br><span class="text-gradient-green">Documen
       <div class="d-flex flex-column gap-3 align-items-center">
         <%- section_title(
           r#"<div class="d-flex gap-2">
-            <h2>Client SDK</h2>
+            <h2>Korvus SDK</h2>
             <div class="language-logos p-2 d-flex gap-2 h-100 rounded-2">
               <img  width="28px" height="28px" src="/dashboard/static/images/logos/javascript.png"/>
               <img  width="28px" height="28px" src="/dashboard/static/images/logos/python.png"/>
             </div>
           </div>"#, 
-          "Our Client SDK implements the best practices to streamline development of common ML/AI use cases in JavaScript or Python.")%>
+          "Korvus implements the best practices to streamline development of common ML/AI use cases in JavaScript, Python, C and Rust.")%>
       </div>
       <div class="d-flex flex-column gap-4_5">
         <div class="d-flex flex-column">
@@ -96,11 +96,6 @@ <h2>Client SDK</h2>
       </div>
     </div>
 
-    <div class="mt-5">
-      <%- section_title("<h2>Benchmarks</h2>", "")%>
-      <%- section_links(benchmarks)%>
-    </div>
-
     <div class="container mt-5">
       <div class="row d-flex flex-column flex-xl-row" style="min-height: 39rem;">
         <div class="align-items-center d-flex" style="flex: 1">

Original file line number	Diff line number	Diff line change
`@@ -563,19 +563,19 @@ impl Collection {`
`563`	`563`	`.href(&url.to_string_lossy());`
`564`	`564`	`links.push(parent);`
`565`	`565`	`}`
`566`		`- _ => error!("unhandled link child: {node:?}"),`
	`566`	`+ _ => warn!("unhandled link child: {node:?}"),`
`567`	`567`	`}`
`568`	`568`	`}`
`569`	`569`	`}`
`570`		`- _ => error!("unhandled paragraph child: {node:?}"),`
	`570`	`+ _ => warn!("unhandled paragraph child: {node:?}"),`
`571`	`571`	`}`
`572`	`572`	`}`
`573`	`573`	`}`
`574`		`- _ => error!("unhandled list_item child: {node:?}"),`
	`574`	`+ _ => warn!("unhandled list_item child: {node:?}"),`
`575`	`575`	`}`
`576`	`576`	`}`
`577`	`577`	`}`
`578`		`- _ => error!("unhandled list child: {node:?}"),`
	`578`	`+ _ => warn!("unhandled list child: {node:?}"),`
`579`	`579`	`}`
`580`	`580`	`}`
`581`	`581`	`Ok(links)`