@adminide-stack/yantra-help-browser 12.0.16-alpha.26 → 12.0.16-alpha.28

package/lib/templates/content/scope-api/api-overview.md

@@ -1,67 +1,104 @@
-# API Overview
+# Scope API Overview
 
-Introduction to Yantra's developer API.
+The Scope API lets you integrate Yantra's search and AI capabilities directly into your own applications, workflows, and tools.
 
-## API Capabilities
+---
 
-### Core Features
+## What Is the Scope API?
 
-- **Search API**: Programmatic search functionality
-- **Authentication**: Secure API authentication
-- **Rate Limiting**: Appropriate rate limiting
-- **Documentation**: Comprehensive API documentation
+The Scope API is Yantra's programmatic interface. Anything you can do in the Yantra app, you can automate through the API:
 
-### Advanced Features
+- **Search** — Execute searches programmatically and retrieve structured results.
+- **Conversations** — Create and continue multi-turn AI conversations.
+- **Content management** — Upload, index, and manage documents.
+- **Export** — Retrieve search history, conversations, and analytics data.
+- **Webhooks** — Receive real-time notifications for events.
 
-- **Custom Models**: Access to custom AI models
-- **Batch Processing**: Process multiple requests
-- **Webhooks**: Real-time notifications
-- **SDKs**: Software development kits
+---
 
-## API Access
+## Quick Start
 
-### Authentication
+### 1. Get your API key
 
-- **API Keys**: Secure API key authentication
-- **OAuth**: OAuth 2.0 authentication
-- **JWT Tokens**: JSON Web Token authentication
-- **Rate Limiting**: Request rate limiting
+1. Go to **Settings > API > API Keys**.
+2. Click **Generate New Key**.
+3. Copy the key — it's only shown once.
 
-### Access Levels
+### 2. Make your first request
 
-- **Free Tier**: Limited API access
-- **Pro Tier**: Enhanced API access
-- **Max Tier**: Maximum API access
-- **Enterprise**: Custom API access
+```bash
+curl -X POST https://api.yantra.ai/v1/search \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{"query": "best practices for microservices architecture", "mode": "pro"}'
+```
 
-## API Documentation
+### 3. Parse the response
 
-### Endpoints
+```json
+{
+    "data": {
+        "answer": "Microservices architecture best practices include...",
+        "sources": [{ "title": "...", "url": "...", "snippet": "..." }]
+    },
+    "meta": {
+        "request_id": "req_abc123",
+        "model": "gpt-4o",
+        "latency_ms": 847
+    }
+}
+```
 
-- **Search Endpoints**: Search-related endpoints
-- **User Endpoints**: User management endpoints
-- **Content Endpoints**: Content management endpoints
-- **Analytics Endpoints**: Analytics endpoints
+---
 
-### SDKs and Libraries
+## Core Endpoints
 
-- **Python SDK**: Python development kit
-- **JavaScript SDK**: JavaScript development kit
-- **Node.js SDK**: Node.js development kit
-- **Other Languages**: Additional language support
+| Endpoint                         | Method | Description                               |
+| -------------------------------- | ------ | ----------------------------------------- |
+| `/v1/search`                     | POST   | Execute a search query                    |
+| `/v1/conversations`              | POST   | Start a new conversation                  |
+| `/v1/conversations/:id/messages` | POST   | Add a message to an existing conversation |
+| `/v1/content`                    | POST   | Upload and index a document               |
+| `/v1/content`                    | GET    | List indexed content                      |
+| `/v1/export`                     | GET    | Export user data                          |
+| `/v1/webhooks`                   | POST   | Register a webhook endpoint               |
 
-## Getting Started
+---
 
-### API Setup
+## Authentication
 
-1. **Get API Key**: Obtain API key from account
-2. **Read Documentation**: Review API documentation
-3. **Test Endpoints**: Test API endpoints
-4. **Integrate**: Integrate API into application
+| Method    | Use case         | Header                            |
+| --------- | ---------------- | --------------------------------- |
+| API Key   | Server-to-server | `Authorization: Bearer <key>`     |
+| OAuth 2.0 | User-facing apps | Standard auth code flow with PKCE |
 
-### Best Practices
+---
 
-- **Rate Limiting**: Respect rate limits
-- **Error Handling**: Implement proper error handling
-- **Security**: Use secure authentication
-- **Monitoring**: Monitor API usage
+## Rate Limits
+
+| Plan       | Requests/minute | Concurrent requests |
+| ---------- | --------------- | ------------------- |
+| Free       | 20              | 2                   |
+| Pro        | 100             | 10                  |
+| Team       | 500             | 25                  |
+| Enterprise | Custom          | Custom              |
+
+When rate-limited, the API returns `429 Too Many Requests` with a `Retry-After` header.
+
+---
+
+## SDKs
+
+| Language   | Package       | Install                                  |
+| ---------- | ------------- | ---------------------------------------- |
+| Python     | `yantra-sdk`  | `pip install yantra-sdk`                 |
+| JavaScript | `@yantra/sdk` | `npm install @yantra/sdk`                |
+| Go         | `go-yantra`   | `go get github.com/yantra-app/go-yantra` |
+
+All SDKs include TypeScript types, automatic retry logic, and rate limit handling.
+
+---
+
+## Full Documentation
+
+For detailed endpoint documentation, request/response schemas, error codes, and examples, visit the [API Reference](https://docs.yantra.ai/api).

package/lib/templates/content/search-modes/deep-research.md

@@ -1,68 +1,109 @@
 # Deep Research
 
-Comprehensive research mode for complex topics.
+Deep Research is Yantra's most comprehensive search mode — designed for complex topics that require thorough analysis across dozens of sources.
 
-## Deep Research Features
+---
 
-### Comprehensive Analysis
+## What Deep Research Does
 
-- **Extensive Research**: Thorough exploration of topics
-- **Multiple Sources**: Aggregates information from many sources
-- **Trend Analysis**: Identifies patterns and trends
-- **Long-form Content**: Detailed, comprehensive answers
+When you activate Deep Research, Yantra:
 
-### Advanced Capabilities
+1. **Plans the research** — Breaks your question into sub-questions and identifies the key angles to explore.
+2. **Gathers sources** — Fetches and analyzes 20–50+ sources, including web pages, academic papers, and documents.
+3. **Synthesizes findings** — Cross-references information across all sources to build a comprehensive picture.
+4. **Generates a report** — Delivers a structured, citation-rich response organized by key findings.
 
-- **Multi-angle Analysis**: Different perspectives on topics
-- **Historical Context**: Historical background and context
-- **Future Implications**: Analysis of future implications
-- **Cross-referencing**: Links between related topics
+> **Time:** Deep Research takes 30 seconds to 2 minutes, depending on topic complexity. A progress indicator shows you what stage the research is in.
 
-## Deep Research Process
+---
 
-### Research Methodology
+## When to Use Deep Research
 
-1. **Topic Analysis**: Comprehensive topic analysis
-2. **Source Collection**: Gather extensive sources
-3. **Content Synthesis**: Synthesize information
-4. **Analysis Generation**: Create detailed analysis
-5. **Report Compilation**: Compile comprehensive report
+| Use case            | Example query                                                                            |
+| ------------------- | ---------------------------------------------------------------------------------------- |
+| Literature review   | "What does current research say about the effectiveness of remote work on productivity?" |
+| Market analysis     | "Compare the top 5 project management tools for engineering teams"                       |
+| Strategic planning  | "What are the risks and opportunities of expanding into the EU market in 2025?"          |
+| Technical deep dive | "Explain the trade-offs between microservices and monolithic architecture"               |
+| Competitive intel   | "How does Notion's AI strategy compare to Confluence's?"                                 |
 
-### Quality Assurance
+### When NOT to use it
 
-- **Source Verification**: Verify all sources
-- **Fact Checking**: Cross-check factual claims
-- **Bias Detection**: Identify potential biases
-- **Completeness Check**: Ensure comprehensive coverage
+- Simple factual lookups ("What year was Python created?") → Use Regular search
+- Quick comparisons ("React vs Vue popularity") → Use Pro Search
+- Time-sensitive queries ("stock price right now") → Use Regular search with real-time mode
 
-## Deep Research Benefits
+---
 
-### Comprehensive Coverage
+## Research Report Structure
 
-- **Complete Analysis**: Thorough topic coverage
-- **Multiple Perspectives**: Various viewpoints
-- **Historical Context**: Background information
-- **Future Trends**: Forward-looking analysis
+A typical Deep Research response includes:
 
-### Professional Quality
+| Section               | Description                                                |
+| --------------------- | ---------------------------------------------------------- |
+| **Executive summary** | 2–3 sentence overview of key findings                      |
+| **Key findings**      | Numbered list of the most important insights               |
+| **Detailed analysis** | Organized prose with headers for each subtopic             |
+| **Comparison table**  | When applicable, a table comparing options or perspectives |
+| **Source list**       | 20–50+ cited sources at the bottom                         |
 
-- **Expert-Level Analysis**: Professional-grade analysis
-- **Academic Standards**: Academic-quality research
-- **Publication Ready**: Ready for publication
-- **Citation Quality**: High-quality citations
+---
 
-## Deep Research Use Cases
+## Research Quality Features
 
-### Academic Research
+### Source diversity
 
-- **Thesis Research**: Comprehensive thesis research
-- **Academic Papers**: Research for academic papers
-- **Literature Reviews**: Comprehensive literature reviews
-- **Research Proposals**: Detailed research proposals
+Deep Research deliberately gathers sources from multiple categories:
 
-### Professional Applications
+- Academic papers and preprints
+- Industry reports and whitepapers
+- News articles and journalism
+- Official documentation and guides
+- Community discussions and expert opinions
 
-- **Market Research**: Comprehensive market analysis
-- **Business Strategy**: Strategic business analysis
-- **Policy Analysis**: Policy research and analysis
-- **Investment Research**: Detailed investment analysis
+### Conflict resolution
+
+When sources disagree, Yantra:
+
+- Explicitly notes the disagreement
+- Presents both sides with their supporting evidence
+- Indicates which position has stronger or more recent support
+
+### Confidence indicators
+
+Each finding is tagged with a confidence level based on:
+
+- Number of corroborating sources
+- Source authority and credibility
+- Recency of the data
+
+---
+
+## Customizing Deep Research
+
+### Focus areas
+
+After clicking Deep Research, you can optionally narrow the scope:
+
+- **Academic only** — Limit to peer-reviewed and scholarly sources
+- **Recent only** — Focus on content published within a specified timeframe
+- **Specific domains** — Restrict to particular websites or source types
+
+### Export
+
+Deep Research reports are designed for export:
+
+- **PDF** — Formatted report with all citations
+- **Markdown** — For pasting into documentation or Notion
+- **Google Docs** — Direct export for collaborative editing
+
+---
+
+## Availability
+
+| Plan       | Deep Research access               |
+| ---------- | ---------------------------------- |
+| Free       | 3 per day                          |
+| Pro        | Unlimited                          |
+| Team       | Unlimited for all members          |
+| Enterprise | Unlimited with priority processing |

package/lib/templates/content/search-modes/labs-features.md

@@ -1,83 +1,81 @@
 # Labs Features
 
-Experimental features and beta capabilities.
+Yantra Labs is where we test experimental features before they're ready for general release. Get early access to cutting-edge capabilities and help shape the future of Yantra.
 
-## Labs Overview
+---
 
-### Experimental Features
+## What is Yantra Labs?
 
-- **Beta Testing**: Access to features in development
-- **Early Access**: Be the first to try new capabilities
-- **Feedback Integration**: Help shape new features
-- **Innovation Testing**: Test cutting-edge features
+Labs is an opt-in program that gives you access to features still in development. These features may be:
 
-### Feature Categories
+- **Experimental** — New capabilities being tested for the first time.
+- **Beta** — Features that work well but are being refined based on user feedback.
+- **Preview** — Nearly finished features that will soon graduate to general availability.
 
-- **AI Models**: Latest AI model experiments
-- **Search Modes**: New search capabilities
-- **Interface Features**: UI/UX experiments
-- **Integration Tools**: New integration options
+> **Note:** Labs features may change, break, or be removed without notice. They're not covered by our SLA.
 
-## Available Labs Features
+---
 
-### AI Experiments
+## Current Labs Features
 
-- **New Models**: Latest AI model releases
-- **Custom Models**: Experimental custom models
-- **Multimodal AI**: Text, image, and audio processing
-- **Specialized AI**: Domain-specific AI models
+| Feature                   | Status       | Description                                                            |
+| ------------------------- | ------------ | ---------------------------------------------------------------------- |
+| **Voice Search**          | Beta         | Ask questions using voice input on desktop and mobile                  |
+| **Multi-modal Analysis**  | Experimental | Upload images and get AI analysis alongside text                       |
+| **Collaborative Threads** | Beta         | Multiple users can contribute to the same research thread in real-time |
+| **Custom AI Personas**    | Preview      | Create specialized AI personas with custom instructions and knowledge  |
+| **Canvas Mode**           | Experimental | Visual workspace for organizing search results and notes spatially     |
 
-### Search Experiments
+_This list is updated as features are added or graduated._
 
-- **Advanced Search**: Experimental search modes
-- **Visual Search**: Image-based search capabilities
-- **Voice Search**: Voice interaction experiments
-- **Predictive Search**: Anticipatory search features
+---
 
-## Labs Participation
+## Enabling Labs Features
 
-### How to Access
+1. Go to **Settings > Labs**.
+2. Browse available experimental features.
+3. Toggle on the features you want to try.
+4. Some features may require additional permissions or a specific plan tier.
 
-- **Opt-in Process**: Choose to participate in labs
-- **Feature Toggles**: Enable/disable specific features
-- **Beta Notifications**: Get notified of new features
-- **Feedback Channels**: Provide feedback on features
+### Disabling
 
-### Participation Benefits
+Toggle any Labs feature off at any time. Your data from the feature is preserved for 30 days in case you re-enable it.
 
-- **Early Access**: Try features before general release
-- **Influence Development**: Shape feature development
-- **Exclusive Features**: Access to labs-only features
-- **Community Recognition**: Recognition for participation
+---
 
-## Labs Feedback
+## How to Give Feedback
 
-### Feedback Process
+Your feedback directly influences which Labs features become permanent:
 
-- **Feature Testing**: Test experimental features
-- **Bug Reporting**: Report issues and bugs
-- **Feature Requests**: Suggest improvements
-- **Usage Analytics**: Share usage data
+### In-app feedback
 
-### Feedback Channels
+Every Labs feature has a **feedback button** (💬) in its interface. Click it to:
 
-- **In-app Feedback**: Direct feedback within app
-- **Community Forums**: Labs community discussions
-- **Beta Testing Groups**: Dedicated beta groups
-- **Direct Communication**: Direct developer communication
+- Report a bug
+- Suggest an improvement
+- Rate your experience (1–5 stars)
 
-## Labs Guidelines
+### Labs community
 
-### Usage Guidelines
+Join the **#labs** channel in the Yantra community Discord to:
 
-- **Experimental Nature**: Features may be unstable
-- **Data Privacy**: Labs features may have different privacy
-- **Performance Impact**: May affect system performance
-- **Backup Data**: Keep backups of important data
+- Discuss experimental features with other users
+- Share your use cases and workflows
+- Get tips from the Yantra team on getting the most out of new features
 
-### Best Practices
+---
 
-- **Test Thoroughly**: Test features comprehensively
-- **Report Issues**: Report bugs and issues promptly
-- **Provide Feedback**: Share constructive feedback
-- **Stay Updated**: Keep up with labs updates
+## Feature Graduation
+
+When a Labs feature reaches maturity:
+
+1. **Announcement** — We publish a blog post and in-app notification.
+2. **Migration** — Your data and settings carry over automatically.
+3. **SLA coverage** — Graduated features are covered by our standard uptime SLA.
+4. **Labs toggle removed** — The feature moves to its permanent location in the product.
+
+---
+
+## Availability
+
+Labs access is available on all plans. Some individual features may require Pro or higher due to infrastructure costs.

package/lib/templates/content/search-modes/pro-search.md

@@ -1,67 +1,75 @@
 # Pro Search
 
-Advanced search capabilities for Pro subscribers.
+Pro Search is Yantra's enhanced search mode — delivering deeper analysis, more sources, and smarter follow-ups than Regular search.
 
-## Pro Search Features
+---
 
-### Enhanced Analysis
+## What Pro Search Does Differently
 
-- **Detailed Analysis**: Comprehensive answers with analysis
-- **Multiple Perspectives**: Different viewpoints on topics
-- **Deep Dives**: Thorough exploration of complex topics
-- **Expert Insights**: Professional-level analysis
+| Feature             | Regular Search              | Pro Search                                       |
+| ------------------- | --------------------------- | ------------------------------------------------ |
+| Response depth      | Quick, concise answers      | Detailed analysis with multiple angles           |
+| Sources consulted   | 5–10                        | 10–20                                            |
+| Follow-up questions | Basic suggestions           | Context-aware, multi-layered follow-ups          |
+| Response time       | 1–3 seconds                 | 5–10 seconds                                     |
+| Context window      | 50K tokens                  | 100K tokens                                      |
+| Best for            | Quick lookups, simple facts | Multi-step questions, comparisons, how-to guides |
 
-### Advanced AI Models
+---
 
-- **GPT-4**: Latest and most advanced GPT model
-- **Claude**: Advanced reasoning and analysis
-- **Custom Models**: Specialized models for different use cases
-- **Model Selection**: Choose specific models for queries
+## When to Use Pro Search
 
-## Pro Search Capabilities
+### Ideal use cases
 
-### Advanced Features
+- **Comparisons** — "Compare PostgreSQL and MongoDB for a high-write analytics workload"
+- **How-to guides** — "How do I set up CI/CD with GitHub Actions for a monorepo?"
+- **Multi-part questions** — "What are the pros and cons of serverless, and when should I avoid it?"
+- **Detailed explanations** — "Explain how TLS 1.3 handshake works step by step"
+- **Analysis** — "What caused the 2023 banking crisis and what are the long-term implications?"
 
-- **File Uploads**: Analyze documents and files
-- **Custom Searches**: Tailor searches to your needs
-- **API Access**: Integrate Yantra into your workflow
-- **Export Options**: Save and export your research
+### When Regular Search is better
 
-### Enhanced Results
+- Quick facts ("population of Canada")
+- Definitions ("what is a mutex?")
+- Simple lookups ("React 19 release date")
 
-- **Longer Responses**: More detailed answers
-- **Multiple Sources**: Aggregates more sources
-- **Trend Analysis**: Identifies patterns and trends
-- **Comparative Analysis**: Compares different options
+---
 
-## Pro Search Benefits
+## How to Activate
 
-### Quality Improvements
+### On-demand
 
-- **Better Accuracy**: More accurate responses
-- **Deeper Analysis**: More thorough analysis
-- **Expert-Level Insights**: Professional-grade insights
-- **Comprehensive Coverage**: More complete coverage
+Click the **Pro** toggle below the search bar before submitting your query.
 
-### Productivity Features
+### As default
 
-- **Faster Processing**: Priority processing
-- **Advanced Export**: Multiple export formats
-- **Custom Templates**: Personalized search templates
-- **Batch Processing**: Process multiple queries
+Set Pro Search as your default mode:
 
-## Pro Search Use Cases
+**Settings > Preferences > Search > Default search mode** → Pro Search
 
-### Professional Applications
+### Via keyboard
 
-- **Research Projects**: Academic and professional research
-- **Business Analysis**: Market and business analysis
-- **Content Creation**: Research for content creation
-- **Decision Making**: Data-driven decision making
+Press ⌘ + P (Mac) or Ctrl + P (Windows) to toggle Pro Search on/off before searching.
 
-### Advanced Research
+---
 
-- **Complex Topics**: Multi-faceted research topics
-- **Comparative Studies**: Compare multiple options
-- **Trend Analysis**: Identify and analyze trends
-- **Expert Consultation**: Get expert-level insights
+## Pro Search Workflow
+
+1. **You ask a question.**
+2. **Yantra plans its approach** — You'll see a brief "thinking" indicator showing what sub-questions the AI is exploring.
+3. **Sources are fetched and analyzed** — More sources are consulted than in Regular mode.
+4. **A structured response is generated** — With clear sections, bullet points, and inline citations.
+5. **Smart follow-ups are suggested** — Based on what angles weren't fully covered.
+
+> **Transparency:** Pro Search shows you which sources it consulted and why it prioritized certain results.
+
+---
+
+## Availability
+
+| Plan       | Pro Search queries                 |
+| ---------- | ---------------------------------- |
+| Free       | 5 per day                          |
+| Pro        | Unlimited                          |
+| Team       | Unlimited for all members          |
+| Enterprise | Unlimited with priority processing |