docs: add generating llm providers page

continuedev · Aug 18, 2024 · 9d63609 · 9d63609
1 parent 18ae4d6
commit 9d63609
Show file tree

Hide file tree

Showing 33 changed files with 894 additions and 18 deletions.
diff --git a/docs/docs/reference/Model Providers/assets/Watsonx1.gif b/docs/docs/reference/Model Providers/assets/Watsonx1.gif
diff --git a/docs/docs/reference/llm-providers.md b/docs/docs/reference/llm-providers.md
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -273,6 +273,10 @@ const config = {
             from: "/quickstart",
             to: "/install/vscode",
           },
+          {
+            from: ['/reference/Model%20Providers/:splat*', '/reference/Model Providers/:splat*'],
+            to: '/reference/llm-providers',
+          }
         ],
       },
     ],

diff --git a/docs/generate-references.js b/docs/generate-references.js
@@ -0,0 +1,55 @@
+const fs = require('fs').promises;
+const path = require('path');
+
+async function combineMarkdownFiles(sourceDir, outputFile) {
+    try {
+        console.log(`Reading directory: ${sourceDir}`);
+        const files = await fs.readdir(sourceDir);
+        console.log(`Found ${files.length} files`);
+
+        const markdownFiles = files
+            .filter(file => file.endsWith('.md'))
+            .sort();
+        console.log(`Found ${markdownFiles.length} Markdown files`);
+
+        const pageMeta = `---
+id: llm-providers
+title: LLM Providers
+sidebar_label: 🤖 LLM Providers
+toc_max_heading_level: 2
+description: Overview of the various LLM providers supported by Continue
+keywords: [LLM, language models, AI, machine learning, natural language processing]
+---
+`;
+
+        const autoGeneratedWarning = `
+<!-- 
+WARNING: This file is auto-generated. Any manual changes to this file will be overwritten.
+-->
+`;
+
+        let combinedContent = pageMeta + autoGeneratedWarning;
+
+        for (const file of markdownFiles) {
+            console.log(`Processing file: ${file}`);
+            const filePath = path.join(sourceDir, file);
+            let content = await fs.readFile(filePath, 'utf8');
+
+            // Add one '#' to each heading
+            content = content.replace(/^(#+)\s/gm, '#$1 ');
+
+            combinedContent += `\n\n${content}`;
+        }
+
+        console.log(`Writing combined content to: ${outputFile}`);
+        await fs.writeFile(outputFile, combinedContent.trim());
+        console.log(`Combined Markdown file generated: ${outputFile}`);
+    } catch (error) {
+        console.error('Error combining Markdown files:', error);
+    }
+}
+
+const sourceDirectory = './llm-providers';
+const outputFile = './docs/reference/llm-providers.md';
+
+combineMarkdownFiles(sourceDirectory, outputFile);
diff --git a/...reference/Model Providers/anthropicllm.md → docs/llm-providers/anthropicllm.md b/...reference/Model Providers/anthropicllm.md → docs/llm-providers/anthropicllm.md
diff --git a/docs/docs/reference/Model Providers/azure.md → docs/llm-providers/azure.md b/docs/docs/reference/Model Providers/azure.md → docs/llm-providers/azure.md
diff --git a/...docs/reference/Model Providers/bedrock.md → docs/llm-providers/bedrock.md b/...docs/reference/Model Providers/bedrock.md → docs/llm-providers/bedrock.md
diff --git a/...s/reference/Model Providers/cloudflare.md → docs/llm-providers/cloudflare.md b/...s/reference/Model Providers/cloudflare.md → docs/llm-providers/cloudflare.md
diff --git a/.../docs/reference/Model Providers/cohere.md → docs/llm-providers/cohere.md b/.../docs/reference/Model Providers/cohere.md → docs/llm-providers/cohere.md
diff --git a/...cs/reference/Model Providers/deepinfra.md → docs/llm-providers/deepinfra.md b/...cs/reference/Model Providers/deepinfra.md → docs/llm-providers/deepinfra.md
diff --git a/...ocs/reference/Model Providers/deepseek.md → docs/llm-providers/deepseek.md b/...ocs/reference/Model Providers/deepseek.md → docs/llm-providers/deepseek.md
diff --git a/...docs/reference/Model Providers/flowise.md → docs/llm-providers/flowise.md b/...docs/reference/Model Providers/flowise.md → docs/llm-providers/flowise.md
diff --git a/...cs/reference/Model Providers/freetrial.md → docs/llm-providers/freetrial.md b/...cs/reference/Model Providers/freetrial.md → docs/llm-providers/freetrial.md
diff --git a/...cs/reference/Model Providers/geminiapi.md → docs/llm-providers/geminiapi.md b/...cs/reference/Model Providers/geminiapi.md → docs/llm-providers/geminiapi.md
diff --git a/...odel Providers/huggingfaceinferenceapi.md → .../llm-providers/huggingfaceinferenceapi.md b/...odel Providers/huggingfaceinferenceapi.md → .../llm-providers/huggingfaceinferenceapi.md
diff --git a/...ference/Model Providers/huggingfacetgi.md → docs/llm-providers/huggingfacetgi.md b/...ference/Model Providers/huggingfacetgi.md → docs/llm-providers/huggingfacetgi.md
diff --git a/...ocs/reference/Model Providers/ipex_llm.md → docs/llm-providers/ipex_llm.md b/...ocs/reference/Model Providers/ipex_llm.md → docs/llm-providers/ipex_llm.md
diff --git a/...ocs/reference/Model Providers/llamacpp.md → docs/llm-providers/llamacpp.md b/...ocs/reference/Model Providers/llamacpp.md → docs/llm-providers/llamacpp.md
diff --git a/...cs/reference/Model Providers/llamafile.md → docs/llm-providers/llamafile.md b/...cs/reference/Model Providers/llamafile.md → docs/llm-providers/llamafile.md
diff --git a/...ocs/reference/Model Providers/lmstudio.md → docs/llm-providers/lmstudio.md b/...ocs/reference/Model Providers/lmstudio.md → docs/llm-providers/lmstudio.md
diff --git a/...docs/reference/Model Providers/mistral.md → docs/llm-providers/mistral.md b/...docs/reference/Model Providers/mistral.md → docs/llm-providers/mistral.md
diff --git a/docs/docs/reference/Model Providers/msty.md → docs/llm-providers/msty.md b/docs/docs/reference/Model Providers/msty.md → docs/llm-providers/msty.md
diff --git a/.../docs/reference/Model Providers/ollama.md → docs/llm-providers/ollama.md b/.../docs/reference/Model Providers/ollama.md → docs/llm-providers/ollama.md
diff --git a/.../docs/reference/Model Providers/openai.md → docs/llm-providers/openai.md b/.../docs/reference/Model Providers/openai.md → docs/llm-providers/openai.md
diff --git a/...s/reference/Model Providers/openrouter.md → docs/llm-providers/openrouter.md b/...s/reference/Model Providers/openrouter.md → docs/llm-providers/openrouter.md
diff --git a/...reference/Model Providers/replicatellm.md → docs/llm-providers/replicatellm.md b/...reference/Model Providers/replicatellm.md → docs/llm-providers/replicatellm.md
diff --git a/...cs/reference/Model Providers/sagemaker.md → docs/llm-providers/sagemaker.md b/...cs/reference/Model Providers/sagemaker.md → docs/llm-providers/sagemaker.md
diff --git a/...reference/Model Providers/textgenwebui.md → docs/llm-providers/textgenwebui.md b/...reference/Model Providers/textgenwebui.md → docs/llm-providers/textgenwebui.md
diff --git a/.../reference/Model Providers/togetherllm.md → docs/llm-providers/togetherllm.md b/.../reference/Model Providers/togetherllm.md → docs/llm-providers/togetherllm.md
diff --git a/docs/docs/reference/Model Providers/vllm.md → docs/llm-providers/vllm.md b/docs/docs/reference/Model Providers/vllm.md → docs/llm-providers/vllm.md
diff --git a/...docs/reference/Model Providers/watsonx.md → docs/llm-providers/watsonx.md b/...docs/reference/Model Providers/watsonx.md → docs/llm-providers/watsonx.md
@@ -7,9 +7,6 @@ Watsonx, developed by IBM, offers a variety of pre-trained AI foundation models
 To access the Watsonx models, create an instance in the [IBM cloud](https://cloud.ibm.com) which supports watsonx studio. Then to create a project refer [this](https://www.ibm.com/docs/en/watsonx/saas?topic=projects-creating-project).
 
 You can set it up in two different ways :
+
 1. **Using API** : Create Your IBM cloud API key by referring [this](https://www.ibm.com/docs/en/mas-cd/continuous-delivery?topic=cli-creating-your-cloud-api-key).
 2. **Using Credentials** : Use your Username and Password to authenticate
-
-
-## Usage
-![usage-gif](../Model%20Providers/assets/Watsonx1.gif)
diff --git a/docs/package.json b/docs/package.json
@@ -5,15 +5,16 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
-    "start": "nodemon --watch sidebars.js --watch docusaurus.config.js --exec 'docusaurus start'",
+    "start": "npm run genereate-references && nodemon --watch sidebars.js --watch docusaurus.config.js --exec 'docusaurus start'",
     "build": "docusaurus build",
     "build:netlify": "docusaurus build --out-dir build/docs",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
-    "write-heading-ids": "docusaurus write-heading-ids"
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "genereate-references": "node generate-references.js"
   },
   "dependencies": {
     "@docusaurus/core": "^3.4.0",

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -91,18 +91,7 @@ const sidebars = {
   ],
   referenceSidebar: [
     "reference/config",
-    {
-      type: "category",
-      label: "🤖 LLM Providers",
-      collapsible: true,
-      collapsed: true,
-      items: [
-        {
-          type: "autogenerated",
-          dirName: "reference/Model Providers",
-        },
-      ],
-    },
+    "reference/llm-providers",
     "reference/embedding-providers",
     "reference/reranking-providers",
   ],