Add providers section in documentation and put current docs under it (A…

…ll-Hands-AI#3905)
zchn · Sep 17, 2024 · fa0d9cf · fa0d9cf
1 parent 07a094e
commit fa0d9cf
Show file tree

Hide file tree

Showing 3 changed files with 104 additions and 74 deletions.
diff --git a/docs/modules/usage/llms/azure-llms.md b/docs/modules/usage/llms/azure-llms.md
@@ -1,4 +1,4 @@
-# Azure OpenAI LLM
+# Azure
 
 OpenHands uses LiteLLM for completion calls. You can find their documentation on Azure [here](https://docs.litellm.ai/docs/providers/azure).
 

diff --git a/docs/modules/usage/llms/google-llms.md b/docs/modules/usage/llms/google-llms.md
@@ -1,4 +1,4 @@
-# Google Gemini/Vertex LLM
+# Google Gemini/Vertex
 
 OpenHands uses LiteLLM for completion calls. The following resources are relevant for using OpenHands with Google's LLMs:
 

diff --git a/docs/sidebars.ts b/docs/sidebars.ts
@@ -2,82 +2,112 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
 
 const sidebars: SidebarsConfig = {
   apiSidebar: [require("./modules/python/sidebar.json")],
-  docsSidebar: [{
-    type: 'doc',
-    label: 'Getting Started',
-    id: 'usage/getting-started',
-  }, {
-    type: 'doc',
-    label: 'Troubleshooting',
-    id: 'usage/troubleshooting/troubleshooting',
-  }, {
-    type: 'doc',
-    label: 'Feedback',
-    id: 'usage/feedback',
-  }, {
-    type: 'category',
-    label: 'How-to Guides',
-    items: [{
+  docsSidebar: [
+    {
       type: 'doc',
-      id: 'usage/how-to/cli-mode',
-    }, {
+      label: 'Getting Started',
+      id: 'usage/getting-started',
+    },
+    {
       type: 'doc',
-      id: 'usage/how-to/headless-mode',
-    }, {
+      label: 'Troubleshooting',
+      id: 'usage/troubleshooting/troubleshooting',
+    },
+    {
       type: 'doc',
-      id: 'usage/how-to/custom-sandbox-guide',
-    }, {
+      label: 'Feedback',
+      id: 'usage/feedback',
+    },
+    {
+      type: 'category',
+      label: 'How-to Guides',
+      items: [
+        {
+          type: 'doc',
+          id: 'usage/how-to/cli-mode',
+        },
+        {
+          type: 'doc',
+          id: 'usage/how-to/headless-mode',
+        },
+        {
+          type: 'doc',
+          id: 'usage/how-to/custom-sandbox-guide',
+        },
+        {
+          type: 'doc',
+          id: 'usage/how-to/evaluation-harness',
+        },
+        {
+          type: 'doc',
+          id: 'usage/how-to/openshift-example',
+        }
+      ]
+    },
+    {
+      type: 'category',
+      label: 'LLMs',
+      items: [
+        {
+          type: 'doc',
+          label: 'Overview',
+          id: 'usage/llms/llms',
+        },
+        {
+          type: 'category',
+          label: 'Providers',
+          items: [
+            {
+              type: 'doc',
+              label: 'OpenAI',
+              id: 'usage/llms/openai-llms',
+            },
+            {
+              type: 'doc',
+              label: 'Azure',
+              id: 'usage/llms/azure-llms',
+            },
+            {
+              type: 'doc',
+              label: 'Google',
+              id: 'usage/llms/google-llms',
+            },
+            {
+              type: 'doc',
+              label: 'Groq',
+              id: 'usage/llms/groq',
+            },
+            {
+              type: 'doc',
+              label: 'Local/ollama',
+              id: 'usage/llms/local-llms',
+            }
+          ],
+        },
+      ],
+    },
+    {
+      type: 'category',
+      label: 'Architecture',
+      items: [
+        {
+          type: 'doc',
+          label: 'Backend',
+          id: 'usage/architecture/backend',
+        },
+        {
+          type: 'doc',
+          label: 'Runtime',
+          id: 'usage/architecture/runtime',
+        }
+      ],
+    },
+    {
       type: 'doc',
-      id: 'usage/how-to/evaluation-harness',
-    }, {
-      type: 'doc',
-      id: 'usage/how-to/openshift-example',
-    }]
-  }, {
-    type: 'category',
-    label: 'LLMs',
-    items: [{
-      type: 'doc',
-      label: 'Overview',
-      id: 'usage/llms/llms',
-    }, {
-      type: 'doc',
-      label: 'OpenAI',
-      id: 'usage/llms/openai-llms',
-    }, {
-      type: 'doc',
-      label: 'Azure',
-      id: 'usage/llms/azure-llms',
-    }, {
-      type: 'doc',
-      label: 'Google',
-      id: 'usage/llms/google-llms',
-    }, {
-      type: 'doc',
-      label: 'Groq',
-      id: 'usage/llms/groq',
-    }, {
-      type: 'doc',
-      label: 'Local/ollama',
-      id: 'usage/llms/local-llms',
-    }],
-  }, {
-    type: 'category',
-    label: 'Architecture',
-    items: [{
-      type: 'doc',
-      label: 'Backend',
-      id: 'usage/architecture/backend',
-    }, {
-      type: 'doc',
-      label: 'Runtime',
-      id: 'usage/architecture/runtime',
-    }],
-  }, {
-    type: 'doc',
-    label: 'About',
-    id: 'usage/about',
-  }],
+      label: 'About',
+      id: 'usage/about',
+    }
+  ],
 };
 
 export default sidebars;