Merge pull request #44 from bootstrapguru/update-models-docs

Update AI Models Documentation
bootstrapguru · Aug 4, 2024 · c928f2b · c928f2b
2 parents 869349b + a3eb425
commit c928f2b
Show file tree

Hide file tree

Showing 7 changed files with 182 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -1,20 +1,76 @@
-# 🤖 Dexor (Previously droid.dev)
+# 🤖 Dexor
 
-Welcome to **Dexor**, your trusty companion for automating and streamlining your development tasks. Dexor is here to help you stay productive by automating repetitive tasks, identifying and fixing bugs, writing comprehensive test cases, and maintaining a consistent codebase. Checkout the [documentation](https://docs.dexors.dev/) to get started! 
+**Dexor** is your AI-powered coding assistant that transforms the way you develop software. With Dexor, you can:
 
-Checkout the youtube video [here](https://youtu.be/oLmbafcHCKg)
+- 🚀 Accelerate development by automating repetitive tasks
+- 🐛 Identify and fix bugs with AI-driven precision
+- ✅ Generate comprehensive test cases effortlessly
+- 🧹 Maintain a clean and consistent codebase
 
-<p align="center">
-  <a href="https://packagist.org/packages/bootstrapguru/droid"><img src="https://img.shields.io/packagist/dt/bootstrapguru/droid.svg" alt="Total Downloads" /></a>
-  <a href="https://packagist.org/packages/bootstrapguru/droid"><img src="https://img.shields.io/packagist/v/bootstrapguru/droid.svg?label=stable" alt="Latest Stable Version" /></a>
-  <a href="https://packagist.org/packages/bootstrapguru/droid"><img src="https://img.shields.io/packagist/l/bootstrapguru/droid.svg" alt="License" /></a>
-</p>
-<img src="https://raw.githubusercontent.com/bootstrapguru/dexor/main/resources/images/dexor.webp">
+Experience the future of coding – where AI meets your development workflow.
 
-## Documentation
+## 🧠 Supported AI Models
 
-For full documentation, getting started guides, and advanced usage, please visit [docs.dexors.dev](https://docs.dexor.dev/).
+Dexor integrates with multiple AI providers, offering you flexibility and cutting-edge capabilities:
 
-## License
+- **[Anthropic Claude](https://docs.anthropic.com/en/docs/about-claude/models)**: Our top recommendation for its advanced reasoning. Popular model: Claude 3.5 Sonnet (Best)
+- **[OpenAI](https://platform.openai.com/docs/models)**: Access state-of-the-art language models. Popular models: GPT-4o and GPT-4o-mini
+- **[Open Router](https://openrouter.ai/models)**: Tap into a variety of AI models through a single API. Popular model: openrouter/auto
+- **[Ollama](https://ollama.com)**: Run open-source language models locally for enhanced privacy and speed. Popular model: Llama 3.1
+- **[DeepSeek](https://platform.deepseek.com/api-docs/pricing)**: Utilize specialized AI models for deep learning tasks. Popular model: DeepSeek Coder V2
 
-Dexor is an open-source software licensed under the GPL v3 license.
+Choose the AI provider that best suits your project needs and development style. Each offers unique strengths to enhance your coding experience with Dexor.
+
+## 🌐 Discord Community: [![Discord](https://img.shields.io/discord/YOUR_DISCORD_SERVER_ID?color=7289da&label=Discord&logo=discord&logoColor=ffffff)](https://discord.gg/DRzG5a3u4x)
+
+
+## 🚀 Quick Start
+
+### Requirements
+
+Before installing Dexor, ensure your system has:
+- PHP version 8.2.0 or higher
+
+### Installation
+
+Choose your preferred installation method:
+
+#### Via Curl
+
+```sh
+curl -L https://github.com/bootstrapguru/dexor/releases/latest/download/dexor -o /usr/local/bin/dexor
+chmod +x /usr/local/bin/dexor
+```
+
+#### Via Composer
+
+```sh
+composer global require bootstrapguru/dexor
+```
+
+### Usage
+
+Activate Dexor with:
+
+```sh
+dexor
+```
+
+To create a new assistant:
+
+```sh
+dexor --new
+```
+
+## 📚 Documentation
+
+For comprehensive documentation, detailed getting started guides, and advanced usage, please visit our [official documentation](https://docs.dexors.dev/).
+
+## 🎥 Video Tutorial
+
+Check out our YouTube video tutorial [here](https://youtu.be/oLmbafcHCKg) for a visual guide to getting started with Dexor.
+
+
+## 📄 License
+
+Dexor is open-source software licensed under the GPL v3 license.
diff --git a/app/Tools/UpdateFile.php b/app/Tools/UpdateFile.php
@@ -18,12 +18,14 @@ public function handle(
         string $replace_objects_json,
     ): string {
 
-        // Decode the JSON string into an array
-        $replace_objects = json_decode($replace_objects_json, true);
+        try {
+            $replace_objects = json_decode($replace_objects_json, true);
+        } catch (\Exception $e) {
+            return 'Invalid JSON format for replace_objects: '.$replace_objects_json;
+        }
 
-        // Debug: Dump the replace objects
         render(view('tool', [
-            'name' => 'UpdateFile',
+            'name' => 'UpdateFile: '.$file_path,
             'output' => 'Replace objects: '.print_r($replace_objects, true),
         ]));
 
@@ -40,17 +42,26 @@ public function handle(
         $fileContent = Storage::get($file_path);
 
         render(view('tool', [
-            'name' => 'UpdateFile',
+            'name' => 'UpdateFile: '.$file_path,
             'output' => 'Updating content in the file....',
         ]));
 
-        // Loop through the objects and apply the changes
-        foreach ($replace_objects as $object) {
-            if (isset($object['find']) && isset($object['replace'])) {
-                // Replace the text in the file content
-                $fileContent = str_replace($object['find'], $object['replace'], $fileContent);
+        try {
+            // Loop through the objects and apply the changes
+            foreach ($replace_objects as $object) {
+                if (isset($object['find']) && isset($object['replace'])) {
+                    // Replace the text in the file content
+                    $fileContent = str_replace($object['find'], $object['replace'], $fileContent);
+                }
             }
         }
+        catch (\Exception $e) {
+            render(view('tool', [
+                'name' => 'UpdateFile: '.$file_path,
+                'output' => 'Error updating the file: '.$e->getMessage(),
+            ]));
+            return 'Error updating the file: '.$e->getMessage();
+        }
 
         // Update the file with the new content
         Storage::put($file_path, $fileContent);

diff --git a/builds/dexor b/builds/dexor
diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs
@@ -18,7 +18,8 @@ export default defineConfig({
                   { text: 'Who am I', link: '/who-am-i' },
                   { text: 'Getting Started', link: '/getting-started' },
                   { text: 'Onboarding', link: '/onboarding' },
-                  { text: 'Features', link: '/features' }
+                  { text: 'Features', link: '/features' },
+                  { text: 'Models', link: '/models' }
               ]
           },
           {
@@ -39,7 +40,8 @@ export default defineConfig({
       ],
 
       socialLinks: [
-          { icon: 'github', link: 'https://github.com/bootstrapguru/dexor.dev' }
+          { icon: 'github', link: 'https://github.com/bootstrapguru/dexor' },
+          { icon: 'discord', link: 'https://discord.gg/DRzG5a3u4x' }
       ]
   }
 })
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,5 +1,14 @@
 # Getting Started
 
+## Requirements
+
+Before installing Dexor, please ensure that your system meets the following requirements:
+
+- PHP version 8.2.0 or higher
+
+You can check your PHP version by running `php -v` in your terminal.
+
+
 ## Installation
 
 Let me guide you through my installation process. Choose your preferred method: I would choose the first one if I were you! 🤖
@@ -9,18 +18,24 @@ Let me guide you through my installation process. Choose your preferred method:
 Install me with curl:
 
 ```sh
-curl -L https://github.com/bootstrapguru/dexor.dev/releases/latest/download/dexor -o /usr/local/bin/dexor
+curl -L https://github.com/bootstrapguru/dexor/releases/latest/download/dexor -o /usr/local/bin/dexor
 chmod +x /usr/local/bin/dexor
 ```
 
 ### Via Composer
 
-To install me globally using Composer, run:
+To install me globally using Composer, follow these steps:
+
+1. If you don't have Composer installed, please follow the [official Composer installation guide](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos) first.
+
+2. Once Composer is installed, run the following command:
 
 ```sh
-composer global require bootstrapguru/droid
+composer global require bootstrapguru/dexor
 ```
 
+Make sure your global Composer binaries directory is in your system's PATH to run Dexor from anywhere.
+
 ### Via GitHub Release
 
 Alternatively, download my built directory from the latest GitHub release:

diff --git a/docs/index.md b/docs/index.md
@@ -28,4 +28,7 @@ features:
     details: Creates new files and adopts to your existing code structure.
   - title: AI Service Integration
     details: Supports multiple AI services and their respective models for enhanced flexibility.
+  - title: Flexible AI Models
+    details: Choose from a variety of AI models to best suit your development needs.
+    link: /models
 ---
diff --git a/docs/models.md b/docs/models.md
@@ -0,0 +1,67 @@
+# AI Models
+
+Dexor integrates with multiple AI providers, offering you flexibility and cutting-edge capabilities. This page provides an overview of the supported AI models and their key features.
+
+## Supported AI Providers
+
+### Anthropic Claude
+
+**[Anthropic Claude](https://docs.anthropic.com/en/docs/about-claude/models)** is our top recommendation for its advanced reasoning capabilities.
+
+- **Popular Model:** Claude 3.5 Sonnet (Best)
+- **Key Features:** 
+  - Advanced reasoning and problem-solving
+  - Excellent at understanding context and nuance
+  - Strong performance in coding tasks
+
+### OpenAI
+
+**[OpenAI](https://platform.openai.com/docs/models)** provides access to state-of-the-art language models.
+
+- **Popular Models:** GPT-4oo and GPT-4oo-mini
+- **Key Features:**
+  - Highly capable in a wide range of tasks
+  - Strong coding abilities
+  - Constant updates and improvements
+
+### Open Router
+
+**[Open Router](https://openrouter.ai/models)** allows you to tap into a variety of AI models through a single API.
+
+- **Popular Model:** openrouter/auto
+- **Key Features:**
+  - Access to multiple AI models
+  - Automatic model selection based on the task
+  - Flexibility in choosing specific models
+
+### Ollama
+
+**[Ollama](https://ollama.com)** enables you to run open-source language models locally.
+
+- **Popular Model:** Llama 3.1
+- **Key Features:**
+  - Enhanced privacy by running models locally
+  - Faster response times
+  - Customizable and fine-tunable models
+
+### DeepSeek
+
+**[DeepSeek](https://platform.deepseek.com/api-docs/pricing)** offers specialized AI models for deep learning tasks.
+
+- **Popular Model:** DeepSeek Coder V2
+- **Key Features:**
+  - Specialized in coding tasks
+  - Strong performance in code generation and analysis
+  - Continuous improvements in AI coding capabilities
+
+## Choosing the Right Model
+
+Evaluate key factors when selecting an AI model:
+
+1. **Task Complexity:** For more complex reasoning tasks, Claude or GPT-4o might be better suited.
+2. **Privacy Concerns:** If you need to keep your data local, Ollama could be the best choice.
+3. **Coding Specificity:** For coding tasks, Claude and GPT-4o also provide excellent performance, but for cost-effectiveness, consider DeepSeek Coder V2 or GPT-4o-mini.
+4. **Flexibility:** If you need access to a variety of models, Open Router provides a good balance. The openrouter/auto model allows Open Router to select the best model based on a given prompt. However, it's essential to check the usage page in the Open Router dashboard, as costs can escalate if the expensive models are chosen
+5. **Cost:** Consider the pricing models of each provider and how they align with your usage patterns.
+
+Remember, you can always experiment with different models to find the one that works best for your specific needs and workflow.