Merge pull request #20 from ppl-ai/sathvik/test-pr

updated contributing

Author: vikvang

.github/pull_request_template.md

@@ -4,6 +4,7 @@ Brief description of your contribution
 ## Type of Contribution
 - [ ] Example Tutorial
 - [ ] Showcase Project
+- [ ] Article/Integration Guide
 - [ ] Documentation Update
 - [ ] Bug Fix
 - [ ] Other (please describe)

CONTRIBUTING.md

@@ -4,14 +4,17 @@ Thank you for your interest in contributing to our API Cookbook! We welcome high
 
 ## Structure
 
-This cookbook contains two main sections:
+This cookbook contains three main sections:
 
 ### 1. **Examples** (`/docs/examples/`)
 Step-by-step tutorials and example implementations that teach specific concepts or solve common use cases.
 
 ### 2. **Showcase** (`/docs/showcase/`)
 Community-built projects that demonstrate real-world applications of the Sonar API.
 
+### 3. **Articles** (`/docs/articles/`)
+In-depth integration guides and advanced implementation tutorials for complex use cases and integrations with other tools.
+
 ## Contributing Guidelines
 
 ### What We're Looking For
@@ -91,6 +94,15 @@ Any known limitations or considerations users should be aware of.
 4. Include screenshots or demos if applicable
 5. Submit a pull request
 
+### For Articles
+
+1. Fork this repository
+2. Create a new directory under `/docs/articles/your-article-name/`
+3. Add your `README.mdx` file following the structure above
+4. Focus on advanced implementations, integrations, or complex patterns
+5. Include comprehensive code examples and explanations
+6. Submit a pull request
+
 ## Pull Request Template
 
 When submitting a PR, please use this template:
@@ -102,6 +114,7 @@ Brief description of your contribution
 ## Type of Contribution
 - [ ] Example Tutorial
 - [ ] Showcase Project
+- [ ] Article/Integration Guide
 
 ## Checklist
 - [ ] My code follows the cookbook's style guidelines

docs/index.mdx

@@ -1,131 +1,50 @@
 ---
 slug: /
 title: Perplexity Sonar API Cookbook
-description: A comprehensive collection of practical applications, tutorials, and integration guides for Perplexity's Sonar API
+description: A collection of practical examples and guides for building with Perplexity's Sonar API
 keywords: [perplexity, sonar, api, cookbook, examples, tutorials]
 ---
 
-**Build with the best AI answer engine.** A comprehensive collection of practical applications, tutorials, and integration guides built with [**Perplexity's Sonar API**](https://sonar.perplexity.ai/) - the fastest, most cost-effective grounded search APIs with unparalleled real-time, web-wide research and Q&A capabilities.
+# Perplexity Sonar API Cookbook
 
-## 🌟 Why Sonar API?
+A collection of practical examples and guides for building with [**Perplexity's Sonar API**](https://sonar.perplexity.ai/) - the fastest, most cost-effective AI answer engine with real-time search capabilities.
 
-Based on [Perplexity's Sonar platform](https://sonar.perplexity.ai/), this cookbook demonstrates how to leverage:
+## Quick Start
 
-- **⚡ Fastest Performance** - Outperforms the competition with industry-leading speed
-- **💰 Most Affordable** - Sonar's grounding request pricing beats the competition  
-- **🔒 Private & Secure** - No LLM training on your data
-- **🌐 Real-time Search** - Unparalleled web-wide research capabilities
-- **📚 Multiple Models** - From lightweight Sonar to premier Sonar Pro and Deep Research
+To get started with any project in this cookbook:
 
-## 🚀 Getting Started
+1. **Browse examples** - Find the use case that matches your needs
+2. **Follow the guide** - Each example includes complete setup instructions
+3. **Get the code** - Full implementations are available in our [GitHub repository](https://github.com/ppl-ai/api-cookbook)
+4. **Build and customize** - Use the examples as starting points for your projects
 
-To use any project in this cookbook, you'll need:
+## What's Inside
 
-1. **Perplexity API Key** - [Get started here](https://docs.perplexity.ai/home)
-2. **Python 3.7+** - For running the examples
-3. **Basic familiarity** with REST APIs and Python
+### [Examples](/examples)
+Ready-to-run projects that demonstrate specific use cases and implementation patterns.
 
-Each example includes its own setup guide and documentation.
+### [Showcase](/showcase)
+Community-built applications that demonstrate real-world implementations of the Sonar API.
 
----
-
-## 🔧 Examples
-
-### [🔍 Fact Checker CLI](cookbook/examples/fact-checker-cli/)
-Command-line tool that analyzes claims and articles for factual accuracy using Sonar's grounded search.
-- Structured claim analysis with confidence ratings
-- Source citation tracking and verification
-- JSON output for automation workflows
-- Professional fact-checking capabilities
-
-### [🤖 Daily Knowledge Bot](cookbook/examples/daily-knowledge-bot/)
-Automated system delivering interesting facts using Perplexity's AI-powered research.
-- Topic rotation and scheduling support
-- Persistent storage and configuration
-- Educational content generation
-- Customizable knowledge domains
-
-### [🏥 Disease Information App](cookbook/examples/disease-qa/)
-Interactive web application providing structured medical information with Sonar's real-time search.
-- Browser-based interactive interface
-- Structured knowledge cards with citations
-- Medical information lookup and research
-- Standalone deployment ready
-
-### [📚 Academic Research Finder](cookbook/examples/research-finder/)
-CLI tool for discovering and summarizing academic literature with Sonar's research capabilities.
-- Academic source prioritization
-- Citation extraction with DOI tracking
-- Research workflow optimization
-- Literature review automation
-
-## 📖 Integration Guides
-
-In-depth tutorials for advanced implementations:
-
-### [🔗 OpenAI Agents Integration](cookbook/articles/openai-agents-integration/)
-Complete guide for integrating Sonar API with OpenAI Agents SDK.
-- Custom client configuration patterns
-- Async integration examples
-- Function tool implementations
-- Production deployment strategies
-
-### [🧠 Memory Management](cookbook/articles/memory-management/)
-Advanced conversation memory solutions using LlamaIndex with Sonar.
-- Token-aware summarization techniques
-- Vector-based persistence systems
-- Cross-session continuity patterns
-- Production-scalable architectures
-
-## 🎯 Use Cases Covered
-
-This cookbook provides solutions for:
-
-- **🔍 Content Verification** - Fact-checking for journalism and research
-- **📚 Educational Tools** - Knowledge distribution and learning systems
-- **🏥 Information Lookup** - Medical, academic, and professional research
-- **🤖 Conversational AI** - Context-aware chatbots with long-term memory
-- **🔗 API Integration** - Connecting Sonar with existing tools and workflows
-- **📊 Research Automation** - Literature reviews and data synthesis
-
-## 🏢 Trusted by Industry Leaders
-
-Sonar powers products for companies like:
-- **Zoom** - AI Companion 2.0 supercharged with Perplexity's API
-- **Copy.ai** - 8-hour research time savings per rep, 20% throughput increase
-- **Doximity** - Up-to-the-minute clinical answers for physicians
-
-*Source: [Sonar customer stories](https://sonar.perplexity.ai/)*
-
-## 🌐 Sonar API Models
-
-Choose the right model for your use case:
-
-| Model | Best For | Features |
-|-------|----------|----------|
-| **Sonar** | Quick lookups | Lightweight, fast, affordable |
-| **Sonar Pro** | Complex research | Advanced queries, follow-ups |
-| **Reasoning Pro** | Deep analysis | DeepSeek R1 powered reasoning |
-| **Deep Research** | Comprehensive reports | Expert-level research synthesis |
-
-*Learn more: [Sonar API Documentation](https://docs.perplexity.ai/home)*
+### [Integration Guides](/articles)
+In-depth tutorials for advanced implementations and integrations with other tools.
 
-## 🤝 Contributing
+> **Note**: All complete code examples, scripts, and project files can be found in our [GitHub repository](https://github.com/ppl-ai/api-cookbook). The documentation here provides guides and explanations, while the repository contains the full runnable implementations.
 
-We welcome contributions to expand this cookbook! Whether you want to:
+## Contributing
 
-- 🐛 Fix bugs in existing examples
-- ✨ Add new features to current tools
-- 🆕 Contribute entirely new Sonar API applications
-- 📚 Improve documentation and tutorials
+Have a project built with Sonar API? We'd love to feature it! Check our [Contributing Guidelines](https://github.com/ppl-ai/api-cookbook/blob/main/CONTRIBUTING.md) to learn how to:
 
-Please check our [Contributing Guidelines](https://github.com/ppl-ai/api-cookbook/blob/main/CONTRIBUTING.md) for details.
+- Submit example tutorials
+- Add your project to the showcase
+- Improve existing content
 
-## 📄 License
+## Resources
 
-This project is licensed under the [MIT License](https://github.com/ppl-ai/api-cookbook/blob/main/LICENSE).
+- [Sonar API Documentation](https://docs.perplexity.ai/home)
+- [API Playground](https://perplexity.ai/account/api/playground)
+- [GitHub Repository](https://github.com/ppl-ai/api-cookbook)
 
 ---
 
-**Maintained by the Perplexity community**  
-*Powered by [Sonar API](https://sonar.perplexity.ai/) - Where Knowledge Begins* 
+*Maintained by the Perplexity community*