diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 000000000..80a143905 Binary files /dev/null and b/.DS_Store differ diff --git a/favicon.png b/favicon.png new file mode 100644 index 000000000..3fe714d5b Binary files /dev/null and b/favicon.png differ diff --git a/favicon.svg b/favicon.svg index 6a3233265..73b7c500a 100644 --- a/favicon.svg +++ b/favicon.svg @@ -1,49 +1,41 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/favicon_old.svg b/favicon_old.svg new file mode 100644 index 000000000..6a3233265 --- /dev/null +++ b/favicon_old.svg @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/guides/AI-agent.mdx b/guides/AI-agent.mdx new file mode 100644 index 000000000..324fd3deb --- /dev/null +++ b/guides/AI-agent.mdx @@ -0,0 +1,53 @@ + +This guide will walk you through the process of configuring your AI voice agent in Ordibl to ensure it represents your brand effectively when handling calls. + +### Accessing the AI Agent Settings + +- Log in to your [Ordibl Dashboard](https://app.ordibl.ai) +- Locate and click on the **"AI Agent"** option in the main navigation menu +- This will open the AI agent configuration interface + + + + +### Configuring Your AI Agent (Using Pre-Trained Models) + +- Click on the "Create New Agent" button or select an existing agent to edit +- Select Template from the Agent Personality Type +- Choose between Inbound or Outbound call types +- Select the Industry and AI agent type (e.g., Customer Service, Sales, etc.) +- Choose the AI agent's name (this will be how the agent introduces itself) +- Save the agent name and model type +- Define your agent's voice type (select from available voice options) +- Select the knowledge base for the agent (this is where the AI will pull information from) +- Save the AI voice agent configuration + + + + +### Configuring your AI agent (Using Custom Models) +- Click on the "Create New Agent" button or select an existing agent to edit +- Select "Custom" from the Agent Personality Type +- Choose between Inbound or Outbound call types +- Choose the AI agent's name (this will be how the agent introduces itself) +- Create the first message for the agent (this is the first thing the agent will say when it answers a call) +- Create the System prompt (this is the instruction that will guide the AI agent's behavior) +- Select the Provider and Model to use for the agent +- Optional: You can you use your own API key for the provider +- Set other parameters like temperature and max tokens +- Save the AI voice agent configuration + + + + + + +## Important Tips + +- Create a persona that aligns with your brand voice and values +- Provide clear guidelines for how the agent should handle different scenarios +- Test your agent with sample conversations before deploying +- Update your agent's knowledge regularly through the Knowledge Base feature +- Monitor your agent's performance and refine settings as needed + +A well-configured AI agent will provide consistent, professional customer service that represents your brand effectively while handling routine inquiries efficiently. \ No newline at end of file diff --git a/guides/batch-call.mdx b/guides/batch-call.mdx new file mode 100644 index 000000000..fca0e7020 --- /dev/null +++ b/guides/batch-call.mdx @@ -0,0 +1,52 @@ +This guide will walk you through the process of setting up an outbound call agent in Ordibl to schedule and manage batch calls to customers or prospects. + + +### Accessing the Batch Calls Feature + +- Log in to your [Ordibl Dashboard](https://app.ordibl.ai) +- Navigate to the **"Batch Calls"** section in the main menu +- This will open the outbound calling management interface + + + + +Note: The batch call requires two previously additional set up: +- **AI Agent**: You need to have an Outbound AI agent configured with a voice profile and conversation script. +- **Phone Number**: You need to have a phone number assigned to your AI agent for making outbound calls. + +### Creating a New Outbound Call Agent + +4. Click on the "Create New Batch Call" button +5. Enter a descriptive name for your outbound call agent/campaign +6. Select the AI voice profile you wish to use for these calls + + + + + +You can use either a single number or upload a csv file with multiple numbers. The CSV file should contain a list of phone numbers you want to call. + + + +
+ + + + +### Configuring Call Parameters + +- Define your target audience by uploading a contact list or selecting from existing contacts +- Format your contact data appropriately (ensure phone numbers are in the correct format) +Note: A template for the contact list is available for download + + +## Important Tips + +- Test your outbound call agent with a small sample before large-scale deployment +- Ensure compliance with local calling regulations and hours +- Monitor initial calls to verify script effectiveness and adjust as needed +- Include clear company identification in your scripts +- Provide an opt-out mechanism for recipients +- Review call analytics to optimize performance + +Your outbound call agent will now be able to automatically place calls according to your configured parameters, handling routine outreach while collecting valuable data from interactions. \ No newline at end of file diff --git a/guides/call-log.mdx b/guides/call-log.mdx new file mode 100644 index 000000000..4ec7b4fe9 --- /dev/null +++ b/guides/call-log.mdx @@ -0,0 +1,73 @@ +This guide will help you understand and utilize the Call Logs feature in Ordibl to track, analyze, and manage all calls handled by your AI agent. + +## Navigating to Call Logs + +1. Log in to your [Ordibl Dashboard](https://app.ordibl.ai) +2. Locate and click on the *"Call Logs"* option in the left navigation sidebar +3. The Call Logs screen will display with a summary of all call activity. + +The Call Logs dashboard provides a comprehensive overview of your call activity with several key metrics: + +### Call Summary Cards +- **Total Calls**: Number of all calls in the selected period (Last 30 days) +- **Completed Calls**: Successfully processed calls +- **Missed Calls**: Calls that weren't answered by your AI agent +- **Abandoned Calls**: Calls where the caller hung up prematurely + + + + +### Call Log Table +The detailed call log table includes the following columns: +- **AI Agent**: Name of the AI agent that handled the call +- **Phone Number**: The caller's phone number +- **Customer**: Name of the caller (if identified) +- **Call Duration**: Length of the call in seconds +- **Date**: When the call occurred +- **End Reasons**: How the call concluded (customer-ended, assistant-forwarded, silence-timeout) +- **Call Cost**: The exact cost of each call (USD) +- **Actions**: Options to remove log entries + + + + +## Advanced Call Log Features + +### Viewing Call Transcripts + +- Click on a specific call in the log +- Access the complete transcript showing the entire conversation +- Review what was said by both the caller and your AI agent +- Download or play the call audio of the conversation + + + + +### Cost Breakdown Analysis +- Select a call to view its detailed cost information +- See the cost structure based on: + - Call duration + - LLM (Language Model) usage + - Ordibl API usage & associated costs + + + + +### Conversation Details +1. Access in-depth information about each call +2. View decision paths taken by the AI +3. Analyze sentiment and key moments during the conversation +4. See what knowledge base entries were referenced + + + + + +## Best Practices for Using Call Logs + +- Regularly review call logs to identify common customer inquiries +- Use conversation details to improve your knowledge base content +- Identify calls with longer durations to find opportunities for optimization +- Track end reasons to understand call completion patterns + +By effectively utilizing the Call Logs feature, you can gain valuable insights into your AI agent's performance, optimize costs, and continuously improve your automated customer service experience. \ No newline at end of file diff --git a/guides/card-payment.mdx b/guides/card-payment.mdx new file mode 100644 index 000000000..e69de29bb diff --git a/guides/dashboard.mdx b/guides/dashboard.mdx new file mode 100644 index 000000000..50d351755 --- /dev/null +++ b/guides/dashboard.mdx @@ -0,0 +1,103 @@ +The Ordibl Dashboard serves as your command center for monitoring, analyzing, and managing all aspects of your AI-powered calling operations. This comprehensive guide will help you navigate and make the most of your dashboard's features. + + + + +## Accessing Your Dashboard + +1. Log in to your [Ordibl account](https://app.ordibl.ai) +2. You'll automatically land on the Dashboard page +3. If you're in another section, click on "Dashboard" in the left navigation panel + +## Dashboard Overview + +Your Ordibl Dashboard is designed to provide a clear snapshot of your AI calling performance with key metrics and visualizations. + +### Key Performance Metrics (Top Section) + +The dashboard displays five essential metrics for the last 30 days: + +1. **Total Calls**: The number of all calls made or received (32 in the example) +2. **Completed Calls**: Successfully connected and finished calls (32 in the example) +3. **Total Call Seconds**: Cumulative duration of all calls (2758.16 seconds in the example) +4. **Total Spent**: Your total expenditure on calls ($22.23 in the example) +5. **Average Cost Per Call**: The mean cost per call ($0.69 in the example) + +Each metric includes: +- Current value +- "Last 30 days" timeframe indicator +- Trend indicator showing increase/decrease + +### Call Volume Graph (Middle Section) + +The interactive call volume graph shows: +- Call distribution over time +- Y-axis showing number of calls (0-32 in the example) +- X-axis showing months (Jan-Dec) +- A bell curve showing call concentration (peaked in April-May in the example) +- Time period filter option ("By Month" dropdown in the top right) + + + + + +### Call Log History (Bottom Section) + +The detailed call history table includes: +- **AI Agent**: The name of the AI agent that handled the call +- **Phone Number**: The contact's phone number +- **Customer**: Customer name or identifier +- **Call Duration**: Length of each call in seconds +- **Date**: When the call occurred +- **End Reasons**: How the call concluded (customer-ended, assistant-forwarded) +- **Call Cost**: Individual cost for each call in USD + + + + +## Navigation Menu (Left Sidebar) + +The left sidebar provides access to all major sections: + +- **Dashboard**: Overview of call performance and metrics (current page) +- **Knowledge Base**: Manage information sources for your AI +- **AI Agents**: Configure and manage your AI agents +- **Phone Number**: Manage your phone numbers +- **Batch Calls**: Schedule and manage bulk calling campaigns +- **Task/Action**: Configure tasks for your AI agents +- **Call Logs**: Detailed records of all calls +- **Integrations**: Connect with CRM and other systems +- **Settings**: Configure your account and preferences
+ +[At the top right corner] +- **User Profile**: Manage your account settings and preferences + +## Account Information (Bottom Left) + +The bottom left section displays: +- **Pay-As-You-Go**: Your current billing plan +- **Next Due Date**: Your next billing date (1/06/2025) +- **For Enterprise**: Contact Sales link for upgrading +- **Logout**: Option to sign out + + + + +## Live Support + +A chat bubble icon appears in the bottom right corner, providing instant access to support. + +## Using Dashboard Data Effectively + +- Use dashboard insights to determine when to add or adjust AI agents +- Plan knowledge base updates based on call performance + + +## Best Practices + +- Check your dashboard regularly to spot trends early +- Use insights to refine your AI conversation flows +- Compare performance across different time periods +- Review specific call logs for quality assurance + +By effectively using your Ordibl Dashboard, you can optimize your AI calling operations, control costs, and continuously improve customer interactions. \ No newline at end of file diff --git a/guides/integration.mdx b/guides/integration.mdx new file mode 100644 index 000000000..3a68777cf --- /dev/null +++ b/guides/integration.mdx @@ -0,0 +1,91 @@ + +This guide will help you set up and manage CRM integrations within Ordibl, allowing your AI agents to make outbound calls to contacts from your existing CRM platforms. + +## Benefits of CRM Integration + +- Sync your existing customer data with Ordibl +- Enable AI agents to make outbound calls to your CRM contacts +- Maintain consistent customer records across systems +- Leverage customer insights for more effective conversations +- Automate follow-ups and engagement + + + + + +## Available CRM Integrations + +Ordibl currently supports the following CRM platforms: +- **Zoho CRM** - A flexible CRM that brings together sales, marketing, and support in one platform +- **Hubspot** - Inbound-focused tools for marketing, sales, and service to nurture customer relationships +- **Microsoft 365** - CRM capabilities with familiar productivity apps for streamlined collaboration +- **Pipedrive** - Sales-focused CRM that visualizes your pipeline, helping close deals more efficiently +- **Zendesk** - A customer support platform for managing tickets, interactions, and self-service channels +- **Salesforce** - *(Coming Soon)* A leading cloud-based CRM suite for sales, service, and marketing + +### Access the CRM Integration Page +- Log in to your [Ordibl dashboard](https://app.ordibl.ai) +- Navigate to **"Integrations"** in the left sidebar +- Browse the available CRM providers +- Identify your current CRM system +- Click the "Connect" button beside your chosen provider + + + + + +### Authentication +- You'll be redirected to your CRM's authentication page +- Enter your CRM login credentials +- Approve the requested permissions for Ordibl +- Wait for the connection to be established + +### Configure Data Syncing +- Select which contact lists to import +- Choose which contact fields to sync (name, phone, email, etc.) +- Set up sync frequency (manual, daily, hourly) +- Configure contact filters if needed + + + + +### Additional Configuration +- Assign AI agents to your imported contact lists +- Make sure the AI Agent you selected is configured for Outboud calls + + + + + + + +### Test Your Integration +1. Import a small test group of contacts +2. Schedule a test call campaign +3. Monitor call quality and outcomes +4. Make adjustments as needed + +### Troubleshooting Connection Issues +1. Verify your CRM credentials are current +2. Check that API access is enabled in your CRM settings +3. Ensure proper permissions are granted to Ordibl +4. Contact [support](http://www.ordibl.ai/ContactPage) if connection problems persist + +## Best Practices + +- Regularly audit your contact lists for accuracy +- Segment contacts for more targeted outreach +- Create specific conversation flows for different customer segments +- Set appropriate calling hours to respect customer preferences +- Review call recordings to continuously improve agent performance +- Maintain GDPR/CCPA compliance with proper consent management + +## Coming Soon + +Additional CRM integrations are being developed, including: +- Salesforce (as shown in the image) +- More specialized industry-specific CRM solutions +- Enhanced data syncing capabilities +- Advanced campaign management features + +By connecting your CRM to Ordibl, you can leverage your existing customer data to power intelligent outbound calling campaigns, creating seamless customer experiences while maintaining data consistency across all your business systems. \ No newline at end of file diff --git a/guides/knowledge-base.mdx b/guides/knowledge-base.mdx new file mode 100644 index 000000000..eef3fa5c9 --- /dev/null +++ b/guides/knowledge-base.mdx @@ -0,0 +1,34 @@ +This guide will walk you through the process of adding information sources to your Ordibl Knowledge Base to train your AI voice agent. + +## Step-by-Step Instructions +Accessing the Knowledge Base +- Log in to your [Ordibl Dashboard](https://app.ordibl.ai) +- Locate and click on the **"Knowledge Base"** option in the main navigation menu +- This will take you to the Knowledge Base management area + +## Adding New Sources +- Look for and click the "Add Source" or "+" button + + + + +- Select the type of source you wish to add (document or URL)) +- For documents: Click the file upload area to browse your device or drag and drop files + + + + +- For URLs: Enter the web address in the provided field. Note: **Ensure the URL is publicly accessible and begins with https:// or http://** + + + +- Click "Save" to finalize adding the source to your Knowledge Base + +## Important Notes + - Your AI agent will use this information to answer calls and respond to queries + - Upload company-specific documents like FAQs, product guides, and policies + - Ensure information is accurate and up-to-date for optimal AI performance + - Supported file formats typically include PDF, DOCX, TXT, and other common formats + - Large documents may take longer to process + +Remember that a comprehensive Knowledge Base will significantly improve your AI agent's ability to handle calls effectively and provide accurate information to your customers. \ No newline at end of file diff --git a/guides/phone-number.mdx b/guides/phone-number.mdx new file mode 100644 index 000000000..22acfc982 --- /dev/null +++ b/guides/phone-number.mdx @@ -0,0 +1,39 @@ + +This guide will walk you through the process of purchasing and assigning phone numbers to your Ordibl AI voice agent, allowing customers to call and interact with your automated system. + +### Accessing the Phone Number Feature + +- Log in to your [Ordibl Dashboard](https//app.ordibl.ai) +- Navigate to the **"Phone Number"** section in the main menu +- This will take you to the phone number management interface + + + + +### Purchasing a New Phone Number + +- Click on the "Buy Phone Number" button +- Select your preferred options: + - Choose the country/region for your phone number +- Wait for confirmation that your number has been successfully assigned + + + + + +### Configuring Your New Number + +- Assign the purchased number to your AI agent +- Set up call routing options if needed +- Test your new number by making an inbound call + + + + +## Important Notes + +- Phone numbers typically have a monthly subscription fee **($2/month)** +- Ensure you select a number type that suits your business needs (More countries will be added in the future) +- Numbers can be released back to the provider if no longer needed + +Your AI agent will now be able to receive calls through your newly purchased phone number, providing automated assistance to your customers around the clock. \ No newline at end of file diff --git a/guides/settings.mdx b/guides/settings.mdx new file mode 100644 index 000000000..4a507eade --- /dev/null +++ b/guides/settings.mdx @@ -0,0 +1,73 @@ +This guide will walk you through the process of configuring your settings in Ordibl, with special focus on your business profile and additional settings categories. + +## Settings Categories + +The Ordibl settings menu is organized into four main categories: + +- **Basic Profile** - Your company information and branding +- **Security** - Account protection and access controls +- **Subscription Plan** - Plan selection and billing options +- **Provider Credentials** - Custom API key configuration for AI models + +## Step-by-Step Instructions: Basic Profile + +### Accessing the Settings + +1. Log in to your [Ordibl Dashboard](https://app.ordibl.ai) +2. Click on the **"Settings"** option in the main navigation menu +3. The "Basic Profile" section should appear by default + +### Configuring Your Business Profile + +- Enter your company name in the designated field (Very important for your business identity) +- Input your business contact information: + - Industry type + - Country + - Phone +- Click "Save" or "Update Profile" to finalize your business profile settings + + + + +## Other Settings Categories + +### Security +- Password management +- Two-factor authentication options +- Session timeout preferences +- User access controls and permissions +- Login history and monitoring + + + + + + +### Subscription Plan +- Ordibl subscription is a Pay-As-You-Go model +- For higher usage, you can upgrade to Enterprise plans +- Add a Pyament Method for billing +- View billing history + + + + + +### Provider Credentials +- Add your own API keys for preferred AI models +- Configure custom language model settings +- Manage authentication for external services + + + + + +## Important Notes + +- Your business profile information may appear in communications with customers +- Regularly review security settings to ensure account protection +- Monitor your subscription usage to avoid unexpected charges +- Custom API credentials may require separate accounts with those providers +- Settings changes may require logging out and back in to take full effect + +A properly configured settings profile ensures your Ordibl system accurately represents your organization, maintains appropriate security, operates on the right subscription tier, and utilizes your preferred AI model configurations. \ No newline at end of file diff --git a/guides/task-actions.mdx b/guides/task-actions.mdx new file mode 100644 index 000000000..dc2d3aa6d --- /dev/null +++ b/guides/task-actions.mdx @@ -0,0 +1,60 @@ +This guide will walk you through configuring your Ordibl AI agent to handle booking management through Cal.com integration, enabling your customers to schedule and check appointments automatically. + +## Overview +- **Purpose**: Configure your AI agent to make and check bookings using Cal.com +- **Requirements**: Cal.com API keys and event type IDs +- **Note**: All actions must be assigned to an AI agent to function + +### Accessing the Task/Action Section + +1. Log in to your [Ordibl Dashboard](https://app.ordibl.ai) +2. Locate and click on the **"Task/Action"** option in the left navigation sidebar +3. You'll be taken to the action configuration interface + + + + +### Creating a New Booking Action + +1. Click the "Create New Action" or "Add Action" button +2. Select "Booking Management" from the action type dropdown +3. Give your action a descriptive name (e.g., "Customer Appointment Scheduling") + + + + +### Configuring Cal.com Integration + +- Creating a New Booking Appointment Action +- Look for the "Create New" or "+" button on the Actions & Tasks page +- Select "Booking Appointment" from the available action types +- Select your AI agent from the dropdown menu +- Click "Continue" to proceed +- A modal window will appear with the booking configuration form + + + + +- Fill in the required fields: + - **Action Name**: Give your action a descriptive name (e.g., "Customer Appointment Scheduling") + - **Description**: Provide a brief description of what this action does + - **Booking URL**: Enter your Cal.com booking URL + - This should be in the format: `https://cal.com/{username}/{content}` + - This is the public-facing booking page for your calendar + - **API Key**: Enter your Cal.com API key + - If you don't have one yet, click the "Get API Key" button to be directed to Cal.com + - **Event Type ID**: Enter the Event Type ID from Cal.com + - This can be found at `https://app.cal.com/event-types/{EventID}` + + + +## Important Notes + +- Ensure your Cal.com account has available slots configured +- API keys should have the proper permissions for creating and reading events +- Keep your API credentials secure and updated +- If you change event types in Cal.com, update your Ordibl configuration +- Create clear conversation templates for your AI to use when discussing booking options +- Consider time zone handling for international customers + +By following this guide, your Ordibl AI agent will be able to seamlessly handle appointment scheduling and verification, providing your customers with an efficient booking experience without human intervention. \ No newline at end of file diff --git a/guides/user-profile.mdx b/guides/user-profile.mdx new file mode 100644 index 000000000..b280a42ea --- /dev/null +++ b/guides/user-profile.mdx @@ -0,0 +1,2 @@ +# User Profile +## This documentation is under construction. Please check back later for updates. \ No newline at end of file diff --git a/images/.DS_Store b/images/.DS_Store new file mode 100644 index 000000000..069632a91 Binary files /dev/null and b/images/.DS_Store differ diff --git a/images/accept-terms.jpeg b/images/accept-terms.jpeg new file mode 100644 index 000000000..7345c785a Binary files /dev/null and b/images/accept-terms.jpeg differ diff --git a/images/ai-agent-custom.png b/images/ai-agent-custom.png new file mode 100644 index 000000000..880add5c2 Binary files /dev/null and b/images/ai-agent-custom.png differ diff --git a/images/ai-agent-dashboard.png b/images/ai-agent-dashboard.png new file mode 100644 index 000000000..9594688cc Binary files /dev/null and b/images/ai-agent-dashboard.png differ diff --git a/images/ai-agent-template.png b/images/ai-agent-template.png new file mode 100644 index 000000000..0c91149b3 Binary files /dev/null and b/images/ai-agent-template.png differ diff --git a/images/batch-call-multiple.png b/images/batch-call-multiple.png new file mode 100644 index 000000000..b8a444734 Binary files /dev/null and b/images/batch-call-multiple.png differ diff --git a/images/batch-call-single.png b/images/batch-call-single.png new file mode 100644 index 000000000..d125a996e Binary files /dev/null and b/images/batch-call-single.png differ diff --git a/images/batch-call.png b/images/batch-call.png new file mode 100644 index 000000000..6d2525d30 Binary files /dev/null and b/images/batch-call.png differ diff --git a/images/call-logs-breakdown.png b/images/call-logs-breakdown.png new file mode 100644 index 000000000..96dd76067 Binary files /dev/null and b/images/call-logs-breakdown.png differ diff --git a/images/call-logs-details.png b/images/call-logs-details.png new file mode 100644 index 000000000..3a78830cd Binary files /dev/null and b/images/call-logs-details.png differ diff --git a/images/call-logs-table.png b/images/call-logs-table.png new file mode 100644 index 000000000..6abf4b663 Binary files /dev/null and b/images/call-logs-table.png differ diff --git a/images/call-logs-transcript.png b/images/call-logs-transcript.png new file mode 100644 index 000000000..246a438f1 Binary files /dev/null and b/images/call-logs-transcript.png differ diff --git a/images/call-logs.png b/images/call-logs.png new file mode 100644 index 000000000..a0c0b71e3 Binary files /dev/null and b/images/call-logs.png differ diff --git a/images/dark-banner.svg b/images/dark-banner.svg new file mode 100644 index 000000000..cfc3b8ec7 --- /dev/null +++ b/images/dark-banner.svg @@ -0,0 +1,6417 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/images/dashboard-1.png b/images/dashboard-1.png new file mode 100644 index 000000000..93f97fc6d Binary files /dev/null and b/images/dashboard-1.png differ diff --git a/images/dashboard-2.png b/images/dashboard-2.png new file mode 100644 index 000000000..8ceba17b7 Binary files /dev/null and b/images/dashboard-2.png differ diff --git a/images/dashboard-3.png b/images/dashboard-3.png new file mode 100644 index 000000000..db616fb56 Binary files /dev/null and b/images/dashboard-3.png differ diff --git a/images/dashboard.jpeg b/images/dashboard.jpeg new file mode 100644 index 000000000..46471d029 Binary files /dev/null and b/images/dashboard.jpeg differ diff --git a/images/dashboard.png b/images/dashboard.png new file mode 100644 index 000000000..5b24af9f3 Binary files /dev/null and b/images/dashboard.png differ diff --git a/images/industry.jpeg b/images/industry.jpeg new file mode 100644 index 000000000..ad7354620 Binary files /dev/null and b/images/industry.jpeg differ diff --git a/images/integration-agent-calling.png b/images/integration-agent-calling.png new file mode 100644 index 000000000..b5deb02ff Binary files /dev/null and b/images/integration-agent-calling.png differ diff --git a/images/integration-agent.png b/images/integration-agent.png new file mode 100644 index 000000000..5f17f8aff Binary files /dev/null and b/images/integration-agent.png differ diff --git a/images/integration-connect.png b/images/integration-connect.png new file mode 100644 index 000000000..936a2824b Binary files /dev/null and b/images/integration-connect.png differ diff --git a/images/integration-contact-list.png b/images/integration-contact-list.png new file mode 100644 index 000000000..b099851d6 Binary files /dev/null and b/images/integration-contact-list.png differ diff --git a/images/integration.png b/images/integration.png new file mode 100644 index 000000000..113b639e6 Binary files /dev/null and b/images/integration.png differ diff --git a/images/kb-upload.png b/images/kb-upload.png new file mode 100644 index 000000000..a9cda3fef Binary files /dev/null and b/images/kb-upload.png differ diff --git a/images/kb-url.png b/images/kb-url.png new file mode 100644 index 000000000..1fc6c4de3 Binary files /dev/null and b/images/kb-url.png differ diff --git a/images/knowledge-source.jpeg b/images/knowledge-source.jpeg new file mode 100644 index 000000000..0907375bf Binary files /dev/null and b/images/knowledge-source.jpeg differ diff --git a/images/landing.jpeg b/images/landing.jpeg new file mode 100644 index 000000000..a8e88f4fc Binary files /dev/null and b/images/landing.jpeg differ diff --git a/images/light-banner.svg b/images/light-banner.svg new file mode 100644 index 000000000..292e44925 --- /dev/null +++ b/images/light-banner.svg @@ -0,0 +1,5147 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/images/login.png b/images/login.png new file mode 100644 index 000000000..e4bdd6804 Binary files /dev/null and b/images/login.png differ diff --git a/images/main-dashboard.png b/images/main-dashboard.png new file mode 100644 index 000000000..72e91444c Binary files /dev/null and b/images/main-dashboard.png differ diff --git a/images/otp.png b/images/otp.png new file mode 100644 index 000000000..4760a9538 Binary files /dev/null and b/images/otp.png differ diff --git a/images/phone-number-purchase.png b/images/phone-number-purchase.png new file mode 100644 index 000000000..adcab6420 Binary files /dev/null and b/images/phone-number-purchase.png differ diff --git a/images/phone-number.png b/images/phone-number.png new file mode 100644 index 000000000..a4b7bf534 Binary files /dev/null and b/images/phone-number.png differ diff --git a/images/proceed.jpeg b/images/proceed.jpeg new file mode 100644 index 000000000..0121973a8 Binary files /dev/null and b/images/proceed.jpeg differ diff --git a/images/setting-basic.png b/images/setting-basic.png new file mode 100644 index 000000000..27bb12d2c Binary files /dev/null and b/images/setting-basic.png differ diff --git a/images/setting-providers.png b/images/setting-providers.png new file mode 100644 index 000000000..c8adb9ccb Binary files /dev/null and b/images/setting-providers.png differ diff --git a/images/setting-security.png b/images/setting-security.png new file mode 100644 index 000000000..0d3fbb8b0 Binary files /dev/null and b/images/setting-security.png differ diff --git a/images/setting-subscription.png b/images/setting-subscription.png new file mode 100644 index 000000000..e949e4589 Binary files /dev/null and b/images/setting-subscription.png differ diff --git a/images/signup.png b/images/signup.png new file mode 100644 index 000000000..2ebb8985f Binary files /dev/null and b/images/signup.png differ diff --git a/images/tools-selection-booking.png b/images/tools-selection-booking.png new file mode 100644 index 000000000..3b7c23dda Binary files /dev/null and b/images/tools-selection-booking.png differ diff --git a/images/tools-selection.png b/images/tools-selection.png new file mode 100644 index 000000000..988e90e97 Binary files /dev/null and b/images/tools-selection.png differ diff --git a/images/tools.png b/images/tools.png new file mode 100644 index 000000000..aa6c5d20d Binary files /dev/null and b/images/tools.png differ diff --git a/images/user-profile.png b/images/user-profile.png new file mode 100644 index 000000000..2819b4041 Binary files /dev/null and b/images/user-profile.png differ diff --git a/introduction.mdx b/introduction.mdx index 2589c0b93..822aa9f6b 100644 --- a/introduction.mdx +++ b/introduction.mdx @@ -1,71 +1,95 @@ --- title: Introduction -description: 'Welcome to the home of your new documentation' +description: 'Create and Deploy your own AI Voice Agent with Ordibl.' --- Hero Light Hero Dark -## Setting up +## Overview -The first step to world-class documentation is setting up your editing environments. +Ordibl.ai AI-powered voice platform designed to make and receive phone calls using artificial intelligence voice agents. It integrates with telecom networks to enable automated or semi-automated voice interactions, such as customer service calls, sales outreach, or information hotlines, using virtual phone numbers. +It automates inbound & outbound calls, supports multilingual communication, and seamlessly integrates with CRMs. - Get your docs set up locally for easy development + View key metrics and insights on your AI voice agent's performance. - Preview your changes before you push to make sure they're perfect + Upload documents and data to train your AI agent. - - -## Make it yours - -Update your docs to your brand and add valuable content for the best user conversion. - - - Customize your docs to your company's colors and brands + Configure your AI agent's settings and persona. - + Assign phone numbers to your AI agent for incoming & outgoing calls. + + - Automatically generate endpoints from an OpenAPI spec + Schedule bulk calls to customers or prospects. + + Review call history, call records and transcripts. + + - Build interactive features and designs to guide your users + Manage tasks and workflows triggered by AI agent interactions. + Connect Ordibl.ai with your favorite tools and platforms. + + + Manage your account settings, billing, and integrations. + + - Check out our showcase of our favorite documentation + Access your account settings and profile information + diff --git a/logo/dark.png b/logo/dark.png new file mode 100644 index 000000000..6d1f8d142 Binary files /dev/null and b/logo/dark.png differ diff --git a/logo/dark.svg b/logo/dark.svg index a6283786c..6c6f4c750 100644 --- a/logo/dark.svg +++ b/logo/dark.svg @@ -1,55 +1,55 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/logo/dark_old.svg b/logo/dark_old.svg new file mode 100644 index 000000000..a6283786c --- /dev/null +++ b/logo/dark_old.svg @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/logo/light.png b/logo/light.png new file mode 100644 index 000000000..ee62230cf Binary files /dev/null and b/logo/light.png differ diff --git a/logo/light.svg b/logo/light.svg index 582b3b95f..e03912566 100644 --- a/logo/light.svg +++ b/logo/light.svg @@ -1,51 +1,55 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/logo/light_old.svg b/logo/light_old.svg new file mode 100644 index 000000000..582b3b95f --- /dev/null +++ b/logo/light_old.svg @@ -0,0 +1,51 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/mint.json b/mint.json index d6f7e33d6..91cf454f1 100644 --- a/mint.json +++ b/mint.json @@ -1,11 +1,11 @@ { "$schema": "https://mintlify.com/schema.json", - "name": "Starter Kit", + "name": "Ordibl Docs", "logo": { - "dark": "/logo/dark.svg", - "light": "/logo/light.svg" + "dark": "/logo/dark.png", + "light": "/logo/light.png" }, - "favicon": "/favicon.svg", + "favicon": "/favicon.png", "colors": { "primary": "#0D9373", "light": "#07C983", @@ -16,76 +16,59 @@ } }, "topbarLinks": [ + + { + "name": "Sign Up", + "url": "https://app.ordibl.ai/signup" + }, + { + "name": "Login", + "url": "https://app.ordibl.ai/signin" + }, { "name": "Support", - "url": "mailto:hi@mintlify.com" + "url": "http://www.ordibl.ai/ContactPage" } ], - "topbarCtaButton": { - "name": "Dashboard", - "url": "https://dashboard.mintlify.com" - }, "tabs": [ { "name": "API Reference", "url": "api-reference" + }, + { + "name": "Changelog", + "url": "changelog" } ], "anchors": [ { "name": "Documentation", - "icon": "book-open-cover", - "url": "https://mintlify.com/docs" - }, - { - "name": "Community", - "icon": "slack", - "url": "https://mintlify.com/community" - }, - { - "name": "Blog", - "icon": "newspaper", - "url": "https://mintlify.com/blog" + "icon": "book-open", + "url": "#" } ], "navigation": [ + { - "group": "Get Started", + "group": "How-to Guides", "pages": [ "introduction", "quickstart", - "development" - ] - }, - { - "group": "Essentials", - "pages": [ - "essentials/markdown", - "essentials/code", - "essentials/images", - "essentials/settings", - "essentials/navigation", - "essentials/reusable-snippets" - ] - }, - { - "group": "API Documentation", - "pages": [ - "api-reference/introduction" - ] - }, - { - "group": "Endpoint Examples", - "pages": [ - "api-reference/endpoint/get", - "api-reference/endpoint/create", - "api-reference/endpoint/delete" + "guides/dashboard", + "guides/knowledge-base", + "guides/AI-agent", + "guides/phone-number", + "guides/batch-call", + "guides/call-log", + "guides/task-actions", + "guides/integration", + "guides/settings" ] } ], "footerSocials": { - "x": "https://x.com/mintlify", - "github": "https://github.com/mintlify", - "linkedin": "https://www.linkedin.com/company/mintsearch" + "x": "https://x.com/ordiblai", + "github": "https://github.com/ReplyiAI", + "linkedin": "https://www.linkedin.com/company/ordibl" } } \ No newline at end of file diff --git a/quickstart.mdx b/quickstart.mdx index d7f348678..056d654ed 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,86 +1,64 @@ --- -title: 'Quickstart' -description: 'Start building awesome documentation in under 5 minutes' +title: 'Getting Started' +description: 'A step-by-step guide to creating an account and logging to Ordibl dashboard' --- -## Setup your development +## How to Create an acccount on Ordibl -Learn how to update your docs locally and and deploy them to the public. +This comprehensive guide will walk you through the process of accessing your Ordibl Dashboard, ensuring you can quickly and securely log in to manage your account. +To create a new Ordibl account, visit the [Ordibl signup page](https://app.ordibl.com/signup) and follow the instructions to register. -### Edit and preview + + + - - - During the onboarding process, we created a repository on your Github with - your docs content. You can find this repository on our - [dashboard](https://dashboard.mintlify.com). To clone the repository - locally, follow these - [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) - in your terminal. - - - Previewing helps you make sure your changes look as intended. We built a - command line interface to render these changes locally. 1. Install the - [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the - documentation changes locally with this command: ``` npm i -g mintlify ``` - 2. Run the following command at the root of your documentation (where - `mint.json` is): ``` mintlify dev ``` - - +### Step 1: Navigate to the Ordibl Website +Open your preferred web browser and enter the Ordibl URL in the address bar. Click on the ["Get Started"](https://app.ordibl.com/signup) button to proceed to register for a new account. + + + +### Step 2: Enter Your Credentials +In the Sign up form, fill in your name and email addres. Then input your password. Ensure your credentials are entered correctly, as the system is case-sensitive. Accept the terms and conditions by checking the box, and then click on the "Sign up" button. -### Deploy your changes + + + - +### Step 3: Choose an Industry +Select the industry that best fits your needs. This helps Ordibl tailor its services to your specific requirements. + + + - - Our Github app automatically deploys your changes to your docs site, so you - don't need to manage deployments yourself. You can find the link to install on - your [dashboard](https://dashboard.mintlify.com). Once the bot has been - successfully installed, there should be a check mark next to the commit hash - of the repo. - - - [Commit and push your changes to - Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) - for your changes to update in your docs site. If you push and don't see that - the Github app successfully deployed your changes, you can also manually - update your docs through our [dashboard](https://dashboard.mintlify.com). - +### Step 5: Enter your OTP +Next, you will receive a One-Time Password (OTP) via email. Check your inbox for an email from Ordibl and enter the OTP in the provided field on the website. This step is crucial for verifying your identity and securing your account. + + + +Upon successful authentication, you will be automatically redirected to your Ordibl Dashboard, where you can access all account features and management tools. - + + + -## Update your docs +# How to Log in to Ordibl +To log in to your Ordibl account, follow these simple steps: +1. Open your web browser and navigate to the [Ordibl login page](https://app.ordibl.com/signin). +2. Enter your registered email address and password in the respective fields. +3. Click the "Sign In" button to access your Ordibl Dashboard. + + + -Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own. +## Troubleshooting - +- **Forgotten Password**: If you cannot remember your password, look for the "Forgot Password" link on the login page to reset it. +- **Account Locked**: After multiple failed login attempts, your account may be temporarily locked. Wait a few minutes before trying again, or contact support. +- **Browser Issues**: Ensure JavaScript is enabled in your browser settings. The Ordibl Dashboard requires JavaScript for full functionality. - - Add flair to your docs with personalized branding. - +## Additional Information - - Implement your OpenAPI spec and enable API user interaction. - +For security purposes, always log out when you're finished using the Ordibl Dashboard, especially when using a shared device or public computer. You can log out by clicking on your profile menu and selecting "Log Out." - - Draw insights from user interactions with your documentation. - +If you encounter any persistent login issues, please contact [Ordibl support](http://www.ordibl.ai/ContactPage) for assistance. - - Keep your docs on your own website's subdomain. - - - diff --git a/sample.mdx b/sample.mdx new file mode 100644 index 000000000..ccbc27e9b --- /dev/null +++ b/sample.mdx @@ -0,0 +1,114 @@ +## Make it yours + +Update your docs to your brand and add valuable content for the best user conversion. + + + + Customize your docs to your company's colors and brands + + + Automatically generate endpoints from an OpenAPI spec + + + Build interactive features and designs to guide your users + + + Check out our showcase of our favorite documentation + + + + + +### Edit and preview + + + + During the onboarding process, we created a repository on your Github with + your docs content. You can find this repository on our + [dashboard](https://dashboard.mintlify.com). To clone the repository + locally, follow these + [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) + in your terminal. + + + Previewing helps you make sure your changes look as intended. We built a + command line interface to render these changes locally. 1. Install the + [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the + documentation changes locally with this command: ``` npm i -g mintlify ``` + 2. Run the following command at the root of your documentation (where + `mint.json` is): ``` mintlify dev ``` + + + +### Deploy your changes + + + + + Our Github app automatically deploys your changes to your docs site, so you + don't need to manage deployments yourself. You can find the link to install on + your [dashboard](https://dashboard.mintlify.com). Once the bot has been + successfully installed, there should be a check mark next to the commit hash + of the repo. + + + [Commit and push your changes to + Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) + for your changes to update in your docs site. If you push and don't see that + the Github app successfully deployed your changes, you can also manually + update your docs through our [dashboard](https://dashboard.mintlify.com). + + + + +## Update your docs + +Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own. + + + + + Add flair to your docs with personalized branding. + + + + Implement your OpenAPI spec and enable API user interaction. + + + + Draw insights from user interactions with your documentation. + + + + Keep your docs on your own website's subdomain. + + +