Add WIP disclaimers + sidebar update to docs

docs/docs/index.md

@@ -1,5 +1,18 @@
+---
+title: Home
+---
+
 # MongoDB RAG Framework
 
+:::warning[👷‍♂️ Work In Progress 👷‍♂️]
+
+The MongoDB RAG Framework is under active development
+and may undergo breaking changes.
+
+We aim to keep the documentation up to date with the latest version.
+
+:::
+
 Build full stack retrieval augmented generation (RAG) applications using MongoDB
 and [Atlas Vector Search](https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-overview/).
 

docs/docusaurus.config.ts

@@ -109,6 +109,11 @@ const config: Config = {
       theme: prismThemes.github,
       darkTheme: prismThemes.dracula,
     },
+    announcementBar: {
+      content:
+        "⚠️ The MongoDB RAG Framework is under active development and may undergo breaking changes. ⚠️",
+      backgroundColor: "#FFF8E6",
+    },
   } satisfies Preset.ThemeConfig,
 };
 

docs/sidebars.ts

@@ -1,4 +1,4 @@
-import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
 
 /**
  * Creating a sidebar enables you to:
@@ -12,23 +12,39 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
  */
 const sidebars: SidebarsConfig = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
-  main: ["index", "quick-start", "mongodb",{
-    type: 'category',
-    label: 'Data Ingest CLI',
-    collapsible: false,
-    collapsed: false,
-    items: ["ingest/configure", "ingest/configuration-reference","ingest/command-reference", "ingest/data-sources", "ingest/fine-tune"]
-  }, {
-    type: 'category',
-    label: 'Chat Server',
-    collapsible: false,
-    collapsed: false,
-    items: ["server/configure", {
-      type: "link",
-      label: "OpenAPI Spec",
-      href: "/server/openapi",
-    }]
-  }, "ui"],
+  main: [
+    "index",
+    "quick-start",
+    "mongodb",
+    {
+      type: "category",
+      label: "Data Ingest CLI",
+      collapsible: false,
+      collapsed: false,
+      items: [
+        "ingest/configure",
+        "ingest/configuration-reference",
+        "ingest/command-reference",
+        "ingest/data-sources",
+        "ingest/fine-tune",
+      ],
+    },
+    {
+      type: "category",
+      label: "Chat Server",
+      collapsible: false,
+      collapsed: false,
+      items: [
+        "server/configure",
+        {
+          type: "link",
+          label: "OpenAPI Spec",
+          href: "/server/openapi",
+        },
+      ],
+    },
+    "ui",
+  ],
 };
 
 export default sidebars;