Merge pull request #1036 from julep-ai/d/docs-improvement

docs(mintlify): Add task walkthrough & other misc improvements
julep-ai · Jan 9, 2025 · 61b3377 · 61b3377
2 parents 6e1d59a + 30835e3
commit 61b3377
Show file tree

Hide file tree

Showing 7 changed files with 617 additions and 55 deletions.
diff --git a/documentation/building-blocks/agents/creating-agents.mdx b/documentation/building-blocks/agents/creating-agents.mdx
@@ -11,29 +11,31 @@ Agents in Julep are AI-powered entities that can execute tasks and interact with
 
 You can create an agent using either the Python or Node.js SDK:
 
-```python Python
-from julep import Julep
+<CodeGroup>
+    ```python Python
+    from julep import Julep
 
-client = Julep(api_key="your_api_key")
+    client = Julep(api_key="your_api_key")
 
-agent = client.agents.create(
-    name="My Agent",
-    model="claude-3.5-sonnet",
-    about="A helpful AI assistant that specializes in data analysis"
-)
-```
+    agent = client.agents.create(
+        name="My Agent",
+        model="claude-3.5-sonnet",
+        about="A helpful AI assistant that specializes in data analysis"
+    )
+    ```
 
-```javascript JavaScript
-import { Julep } from '@julep/sdk';
+    ```javascript JavaScript
+    import { Julep } from '@julep/sdk';
 
-const client = new Julep({ apiKey: 'your_api_key' });
+    const client = new Julep({ apiKey: 'your_api_key' });
 
-const agent = await client.agents.create({
-    name: "My Agent",
-    model: "claude-3.5-sonnet",
-    about: "A helpful AI assistant that specializes in data analysis"
-});
-```
+    const agent = await client.agents.create({
+        name: "My Agent",
+        model: "claude-3.5-sonnet",
+        about: "A helpful AI assistant that specializes in data analysis"
+    });
+    ```
+</CodeGroup>
 
 ## Agent Configuration Options
 
@@ -73,50 +75,54 @@ Julep supports various language models:
 
 Here's an example of creating a more specialized agent with metadata and tools:
 
-```python Python
-agent = client.agents.create(
-    name="Research Assistant",
-    model="claude-3.5-sonnet",
-    about="An AI assistant specialized in academic research and paper analysis",
-    metadata={
-        "expertise": ["academic research", "paper analysis"],
-        "language": "en",
-        "max_papers_per_session": 5
-    }
-)
-
-# Add tools to the agent
-client.agents.tools.create(
-    agent_id=agent.id,
-    name="arxiv_search",
-    description="Search for academic papers on arXiv",
-    integration={
-        "provider": "arxiv",
-        "method": "search"
-    }
-)
-```
+<CodeGroup>
+    ```python Python
+    agent = client.agents.create(
+        name="Research Assistant",
+        model="claude-3.5-sonnet",
+        about="An AI assistant specialized in academic research and paper analysis",
+        metadata={
+            "expertise": ["academic research", "paper analysis"],
+            "language": "en",
+            "max_papers_per_session": 5
+        }
+    )
+
+    # Add tools to the agent
+    client.agents.tools.create(
+        agent_id=agent.id,
+        name="arxiv_search",
+        description="Search for academic papers on arXiv",
+        integration={
+            "provider": "arxiv",
+            "method": "search"
+        }
+    )
+    ```
+</CodeGroup>
 
 ## Managing Agents
 
 Once created, you can manage your agents:
 
-```python Python
-# List all agents
-agents = client.agents.list()
+<CodeGroup>
+    ```python Python
+    # List all agents
+    agents = client.agents.list()
 
-# Get a specific agent
-agent = client.agents.get(agent_id="agent_id")
+    # Get a specific agent
+    agent = client.agents.get(agent_id="agent_id")
 
-# Update an agent
-agent = client.agents.update(
-    agent_id="agent_id",
-    metadata={"new_config": "value"}
-)
+    # Update an agent
+    agent = client.agents.update(
+        agent_id="agent_id",
+        metadata={"new_config": "value"}
+    )
 
-# Delete an agent
-client.agents.delete(agent_id="agent_id")
-```
+    # Delete an agent
+    client.agents.delete(agent_id="agent_id")
+    ```
+</CodeGroup>
 
 ## Next Steps
 

diff --git a/documentation/getting-started/examples.mdx b/documentation/getting-started/examples.mdx
@@ -0,0 +1,29 @@
+Get started quickly with Julep using our example notebooks. These notebooks demonstrate key features and common use cases. Each notebook includes detailed explanations and step-by-step instructions to help you understand and implement these features in your own projects.
+## Browser Automation
+- [Browser Automation Guide](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/06-browser-use.ipynb)
+  - Automated browser control and interaction capabilities
+  - Remote browser session management and control
+
+## Web Crawling & Search
+- [Website Crawler](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/01-website-crawler.ipynb)
+  - Spider integration for website content extraction
+  - Automated data collection from web pages
+
+- [Sarcastic News Headline Generator](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/02-sarcastic-news-headline-generator.ipynb)
+  - Generates witty headlines using Brave Search results
+  - Combines web search with creative content generation
+
+## Travel & Weather
+- [Trip Planning Assistant](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/03-trip-planning-assistant.ipynb)
+  - Smart travel planner with weather data integration
+  - Location-based itinerary generation with weather considerations
+
+## Content Creation
+- [Social Media Hook Generator](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/04-hook-generator-trending-reels.ipynb)
+  - Generates engaging social media hooks and captions
+  - Content optimization for trending topics
+
+## Media Processing
+- [Natural Language Video Processing](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/05-video-processing-with-natural-language.ipynb)
+  - Video processing through natural language commands
+  - FFmpeg integration for media manipulation