Files

ajaysi f5f3c09ecc feat(seo-copilot): caching + freshness UI; glassomorphic styling; CopilotKit HITL modular actions; provider fixes; DB sessions & action types; seed 17 actions

2025-08-30 16:12:41 +05:30

25 KiB

Raw Blame History

ALwrity SEO CopilotKit User Guide

Complete Guide to AI-Powered SEO Optimization

🚀 Getting Started

What is SEO CopilotKit?

SEO CopilotKit is an AI-powered assistant that helps you optimize your website's search engine performance. It provides 16 specialized actions that cover all aspects of SEO, from technical analysis to content optimization.

How to Access SEO CopilotKit

Navigate to the SEO Dashboard in ALwrity
Look for the CopilotKit sidebar (usually on the right side)
The AI assistant will be ready to help with SEO tasks

Basic Interaction

Ask Questions: Type natural language questions about SEO
Request Actions: Ask the AI to perform specific SEO tasks
Get Explanations: Ask for explanations of SEO concepts
Receive Recommendations: Get personalized SEO advice

🤖 Understanding CopilotKit

How It Works

CopilotKit uses AI to understand your SEO needs and execute the appropriate actions. It can:

Analyze your website's SEO performance
Generate optimized content
Provide technical recommendations
Explain SEO concepts in simple terms
Customize your dashboard

Available Context

The AI has access to:

Your current SEO analysis data
Website performance metrics
User preferences and settings
Dashboard layout and configuration
Available actions and suggestions

Response Types

Direct Answers: Immediate responses to questions
Action Results: Results from executed SEO tasks
Recommendations: Personalized suggestions
Explanations: Educational content about SEO

🔍 SEO Analysis Actions

1. Comprehensive SEO Analysis

Action: analyzeSEOComprehensive

What it does: Performs a complete SEO analysis of your website, covering technical, on-page, and content aspects.

How to use:

"Analyze the SEO of my website https://example.com"
"Perform a comprehensive SEO audit for my site"
"Check my website's overall SEO health"

Parameters:

url (required): Your website URL
focusAreas (optional): Specific areas to focus on (performance, content, technical, mobile)

Example Response:

✅ Comprehensive SEO Analysis Complete

📊 Overall SEO Score: 78/100

🔍 Key Findings:
• Technical SEO: Good (85/100)
• On-Page SEO: Needs Improvement (65/100)
• Content Quality: Excellent (90/100)
• Mobile Optimization: Good (80/100)

🚨 Critical Issues Found:
1. Missing meta descriptions on 15 pages
2. Slow page load speed (3.2s average)
3. Broken internal links (8 found)

💡 Recommendations:
1. Add meta descriptions to all pages
2. Optimize images and reduce page size
3. Fix broken internal links
4. Improve mobile responsiveness

2. SEO Health Check

Action: checkSEOHealth

What it does: Quickly assesses your website's overall SEO health and identifies critical issues.

How to use:

"Check my website's SEO health"
"What's my site's SEO score?"
"Identify critical SEO issues"

Parameters:

url (required): Your website URL

Example Response:

🏥 SEO Health Check Results

📈 Health Score: 72/100 (Good)

✅ Strengths:
• Fast loading times
• Mobile-friendly design
• Good content quality

⚠️ Issues to Address:
• Missing alt text on images
• Duplicate meta descriptions
• Poor internal linking structure

🎯 Priority Actions:
1. Add alt text to all images
2. Create unique meta descriptions
3. Improve internal link structure

📝 Content Optimization Actions

3. Meta Description Generation

Action: generateMetaDescriptions

What it does: Creates optimized meta descriptions for your web pages to improve click-through rates.

How to use:

"Generate meta descriptions for my homepage"
"Create SEO-friendly meta descriptions for my blog posts"
"Optimize meta descriptions for my product pages"

Parameters:

url (required): The page URL
keywords (required): Target keywords to include
tone (optional): Professional, casual, or technical

Example Response:

📝 Meta Description Generated

Page: https://example.com/services
Keywords: web design, digital marketing, SEO

Generated Meta Description:
"Transform your business with expert web design, digital marketing, and SEO services. Boost your online presence and drive results with our proven strategies."

📊 Optimization Score: 92/100
✅ Includes target keywords
✅ Optimal length (155 characters)
✅ Compelling call-to-action
✅ Clear value proposition

4. Image Alt Text Generation

Action: generateImageAltText

What it does: Creates SEO-friendly alt text for images to improve accessibility and search rankings.

How to use:

"Generate alt text for my product images"
"Create descriptive alt text for my blog images"
"Optimize alt text for my website images"

Parameters:

imageUrl (required): The image URL
context (optional): Context about the image usage
keywords (optional): Keywords to include

Example Response:

🖼️ Alt Text Generated

Image: /images/product-laptop.jpg
Context: Product page hero image

Generated Alt Text:
"Premium laptop with sleek design for professional use - perfect for business and productivity"

📊 Optimization Score: 88/100
✅ Descriptive and informative
✅ Includes relevant keywords
✅ Appropriate length
✅ Clear and concise

5. OpenGraph Tag Generation

Action: generateOpenGraphTags

What it does: Creates OpenGraph tags for better social media sharing and appearance.

How to use:

"Generate OpenGraph tags for my homepage"
"Create social media tags for my blog posts"
"Optimize social sharing for my products"

Parameters:

url (required): The page URL
title (optional): Page title for OpenGraph
description (optional): Page description for OpenGraph

Example Response:

📱 OpenGraph Tags Generated

Page: https://example.com/blog/seo-tips

Generated Tags:
<meta property="og:title" content="10 Essential SEO Tips for 2024">
<meta property="og:description" content="Discover proven SEO strategies to boost your website's search rankings and drive more organic traffic.">
<meta property="og:image" content="https://example.com/images/seo-tips-og.jpg">
<meta property="og:url" content="https://example.com/blog/seo-tips">
<meta property="og:type" content="article">

📊 Optimization Score: 95/100
✅ Compelling title
✅ Engaging description
✅ High-quality image
✅ Proper URL structure

6. Content Analysis

Action: analyzeContentComprehensive

What it does: Analyzes your content for SEO optimization and provides improvement recommendations.

How to use:

"Analyze my blog post content"
"Check my product descriptions for SEO"
"Review my homepage content"

Parameters:

content (required): The content to analyze
targetKeywords (optional): Target keywords for the content

Example Response:

📄 Content Analysis Results

Content Length: 1,250 words
Target Keywords: "digital marketing services"

📊 Content Score: 78/100

✅ Strengths:
• Good content length
• Well-structured headings
• Engaging writing style
• Relevant information

⚠️ Areas for Improvement:
• Keyword density too low (0.8%)
• Missing internal links
• No call-to-action
• Could use more subheadings

💡 Recommendations:
1. Increase keyword usage naturally
2. Add 3-5 internal links
3. Include a clear call-to-action
4. Break content into more sections

⚙️ Technical SEO Actions

7. Page Speed Analysis

Action: analyzePageSpeed

What it does: Analyzes your website's loading speed and provides optimization recommendations.

How to use:

"Analyze my website's page speed"
"Check loading times for my homepage"
"Optimize my site's performance"

Parameters:

url (required): The URL to analyze
device (optional): Mobile, desktop, or tablet

Example Response:

⚡ Page Speed Analysis

URL: https://example.com
Device: Mobile

📊 Performance Score: 65/100

⏱️ Loading Times:
• First Contentful Paint: 2.1s
• Largest Contentful Paint: 4.2s
• Cumulative Layout Shift: 0.15
• First Input Delay: 180ms

🚨 Issues Found:
• Large images not optimized
• Unused CSS and JavaScript
• No browser caching
• Missing compression

💡 Optimization Recommendations:
1. Compress and resize images
2. Minify CSS and JavaScript
3. Enable browser caching
4. Enable GZIP compression
5. Use a CDN

📈 Expected Improvement: +25 points

8. Sitemap Analysis

Action: analyzeSitemap

What it does: Analyzes your website's sitemap structure and provides optimization recommendations.

How to use:

"Analyze my website's sitemap"
"Check sitemap structure and optimization"
"Review sitemap for SEO issues"

Parameters:

url (required): Your website URL

Example Response:

🗺️ Sitemap Analysis Results

Website: https://example.com

📊 Sitemap Score: 82/100

✅ Strengths:
• Sitemap properly formatted
• All important pages included
• Regular updates
• Good URL structure

⚠️ Issues Found:
• Missing lastmod dates
• No image sitemap
• Missing priority values
• Some broken URLs

💡 Recommendations:
1. Add lastmod dates to all URLs
2. Create an image sitemap
3. Set appropriate priority values
4. Remove or fix broken URLs
5. Submit sitemap to Google Search Console

📈 Pages Indexed: 45/50

9. Technical SEO Analysis

Action: analyzeTechnicalSEO

What it does: Performs a comprehensive technical SEO audit and provides technical recommendations.

How to use:

"Perform technical SEO analysis"
"Check technical SEO issues"
"Audit my site's technical SEO"

Parameters:

url (required): The URL to analyze
focusAreas (optional): Core web vitals, mobile friendliness, security

Example Response:

🔧 Technical SEO Analysis

URL: https://example.com

📊 Technical Score: 78/100

✅ Technical Strengths:
• HTTPS enabled
• Mobile responsive
• Clean URL structure
• Fast loading times

⚠️ Technical Issues:
• Missing schema markup
• No XML sitemap
• Poor internal linking
• Missing robots.txt

🎯 Core Web Vitals:
• LCP: 2.8s (Good)
• FID: 120ms (Good)
• CLS: 0.12 (Needs Improvement)

💡 Technical Recommendations:
1. Implement schema markup
2. Create and submit XML sitemap
3. Improve internal linking structure
4. Add robots.txt file
5. Optimize for Core Web Vitals

10. On-Page SEO Analysis

Action: analyzeOnPageSEO

What it does: Analyzes on-page SEO elements and provides optimization recommendations.

How to use:

"Analyze on-page SEO for my homepage"
"Check on-page optimization"
"Review page-level SEO elements"

Parameters:

url (required): The URL to analyze
targetKeywords (optional): Target keywords to analyze

Example Response:

📄 On-Page SEO Analysis

URL: https://example.com
Target Keywords: "web design services"

📊 On-Page Score: 72/100

✅ On-Page Strengths:
• Good title tag optimization
• Proper heading structure
• Meta description present
• Good content quality

⚠️ On-Page Issues:
• Keyword density too low
• Missing internal links
• No schema markup
• Poor URL structure

📋 Element Analysis:
• Title Tag: 85/100
• Meta Description: 78/100
• Headings: 82/100
• Content: 75/100
• Internal Links: 45/100

💡 On-Page Recommendations:
1. Increase keyword usage naturally
2. Add more internal links
3. Implement schema markup
4. Optimize URL structure
5. Improve content quality

🏢 Advanced SEO Actions

11. Enterprise SEO Analysis

Action: analyzeEnterpriseSEO

What it does: Performs enterprise-level SEO analysis with advanced insights and competitor comparison.

How to use:

"Perform enterprise SEO analysis"
"Compare my SEO with competitors"
"Get enterprise-level SEO insights"

Parameters:

url (required): Your website URL
competitorUrls (optional): Competitor URLs to compare against

Example Response:

🏢 Enterprise SEO Analysis

Website: https://example.com
Competitors: 3 analyzed

📊 Enterprise Score: 76/100

🏆 Competitive Analysis:
• Market Position: 3rd out of 5
• Content Quality: Above Average
• Technical SEO: Average
• User Experience: Good

📈 Performance vs Competitors:
• Organic Traffic: +15% vs average
• Keyword Rankings: +8% vs average
• Page Speed: -5% vs average
• Mobile Experience: +12% vs average

🎯 Enterprise Recommendations:
1. Invest in content marketing
2. Improve technical infrastructure
3. Enhance user experience
4. Implement advanced analytics
5. Develop competitive strategy

💰 ROI Opportunities:
• Content optimization: +25% traffic potential
• Technical improvements: +15% conversions
• UX enhancements: +20% engagement

12. Content Strategy Analysis

Action: analyzeContentStrategy

What it does: Analyzes your content strategy and provides recommendations for improvement.

How to use:

"Analyze my content strategy"
"Review content marketing approach"
"Get content strategy recommendations"

Parameters:

url (required): Your website URL
contentType (optional): Blog, product, or service content

Example Response:

📚 Content Strategy Analysis

Website: https://example.com
Content Type: Blog and Service Pages

📊 Content Strategy Score: 68/100

📈 Content Performance:
• Total Pages: 45
• Blog Posts: 23
• Service Pages: 8
• Product Pages: 14

✅ Content Strengths:
• Regular blog updates
• Good content quality
• Relevant topics
• Proper formatting

⚠️ Content Issues:
• Content gaps identified
• Inconsistent publishing
• Missing content types
• Poor content distribution

🎯 Content Strategy Recommendations:
1. Fill content gaps with targeted articles
2. Establish consistent publishing schedule
3. Create more video and visual content
4. Improve content distribution strategy
5. Develop content calendar

📊 Content Opportunities:
• 15 new topic ideas identified
• 8 content gaps to fill
• 5 content types to add
• 12 distribution channels to explore

13. Website Audit

Action: performWebsiteAudit

What it does: Performs a comprehensive website SEO audit covering all aspects.

How to use:

"Perform a complete website audit"
"Audit my entire website for SEO"
"Get comprehensive SEO audit report"

Parameters:

url (required): Your website URL
auditType (optional): Comprehensive, technical, or content audit

Example Response:

🔍 Comprehensive Website Audit

Website: https://example.com
Audit Type: Comprehensive

📊 Overall Audit Score: 74/100

📋 Audit Summary:
• Pages Analyzed: 45
• Issues Found: 23
• Critical Issues: 5
• Warnings: 12
• Recommendations: 31

🚨 Critical Issues:
1. Missing SSL certificate
2. Broken internal links (8 found)
3. Duplicate content detected
4. Missing meta descriptions (12 pages)
5. Slow loading times

⚠️ Warnings:
1. Missing alt text on images
2. Poor internal linking
3. No XML sitemap
4. Missing schema markup
5. Inconsistent URL structure

✅ Strengths:
1. Good content quality
2. Mobile responsive design
3. Clean URL structure
4. Fast loading on desktop
5. Good user experience

💡 Priority Actions:
1. Fix critical issues first
2. Address warnings systematically
3. Implement recommendations
4. Monitor improvements
5. Schedule follow-up audit

📊 Dashboard & Visualization Actions

14. Update SEO Charts

Action: updateSEOCharts

What it does: Updates SEO performance charts and visualizations with latest data.

How to use:

"Update my SEO performance charts"
"Refresh my SEO dashboard data"
"Show latest SEO metrics"

Parameters:

chartType (required): Performance, rankings, or traffic charts
timeRange (optional): 7d, 30d, 90d, or 1y

Example Response:

📊 SEO Charts Updated

Chart Type: Performance Metrics
Time Range: Last 30 Days

📈 Updated Metrics:
• Organic Traffic: +12% (vs previous period)
• Keyword Rankings: +8% improvement
• Page Speed: +15% faster
• Mobile Experience: +20% better

📊 Chart Data:
• Traffic Growth: Steady upward trend
• Ranking Improvements: 15 keywords moved up
• Performance Gains: Consistent improvement
• User Experience: Enhanced engagement

🎯 Key Insights:
• Mobile optimization showing results
• Content strategy driving traffic growth
• Technical improvements boosting performance
• User engagement increasing steadily

15. Customize SEO Dashboard

Action: customizeSEODashboard

What it does: Customizes your SEO dashboard layout and preferences.

How to use:

"Customize my SEO dashboard"
"Change dashboard layout"
"Add widgets to my dashboard"

Parameters:

layout (required): Grid, list, or compact layout
widgets (optional): Widgets to include

Example Response:

🎨 Dashboard Customized

Layout: Grid Layout
Widgets: Performance, Rankings, Traffic, Issues

✅ Customization Applied:
• Layout changed to grid view
• Performance widget added
• Rankings widget configured
• Traffic widget enabled
• Issues widget displayed

📱 Dashboard Features:
• Responsive grid layout
• Real-time data updates
• Interactive charts
• Quick action buttons
• Customizable widgets

💡 Dashboard Tips:
• Click widgets to expand details
• Drag widgets to rearrange
• Use filters to focus on specific metrics
• Export data for reporting
• Set up alerts for important changes

16. SEO Concept Explanation

Action: explainSEOConcept

What it does: Explains SEO concepts in simple, non-technical terms.

How to use:

"Explain what meta descriptions are"
"What is technical SEO?"
"Help me understand Core Web Vitals"

Parameters:

concept (required): The SEO concept to explain
audience (optional): Beginner, intermediate, or advanced

Example Response:

📚 SEO Concept: Meta Descriptions

🎯 What are Meta Descriptions?
Meta descriptions are short summaries (150-160 characters) that appear under your page title in search results. They tell users what your page is about and encourage them to click.

🔍 Why They Matter:
• Improve click-through rates
• Help users understand your content
• Influence search rankings
• Provide context for search results

💡 Best Practices:
• Keep them under 160 characters
• Include target keywords naturally
• Write compelling, action-oriented text
• Make them unique for each page
• Include a call-to-action when appropriate

📝 Example:
Good: "Learn proven SEO strategies to boost your website's search rankings and drive more organic traffic."
Bad: "SEO tips and tricks for better rankings."

🎯 Pro Tip: Think of meta descriptions as your page's "elevator pitch" - you have a few seconds to convince users to visit your site!

🎯 Best Practices

Getting the Most from SEO CopilotKit

Be Specific: The more specific your requests, the better the results

✅ "Analyze the SEO of https://example.com focusing on mobile performance"
❌ "Check my website SEO"

Use Natural Language: Ask questions as you would to a human expert

✅ "What's wrong with my website's loading speed?"
❌ "Run page speed analysis"

Follow Up: Ask for clarification or additional details

✅ "Can you explain why my page speed is slow?"
✅ "What specific actions should I take to fix this?"

Combine Actions: Use multiple actions for comprehensive analysis

✅ "First analyze my SEO comprehensively, then generate meta descriptions for my main pages"

Regular Monitoring: Use the dashboard actions to track progress

✅ "Update my SEO charts and show me the improvements over the last month"

Common Use Cases

New Website Setup:

"Perform a comprehensive SEO analysis of my new website"
"Generate meta descriptions for all my main pages"
"Create a sitemap and optimize it"

Content Optimization:

"Analyze my blog post content for SEO"
"Generate alt text for my product images"
"Create OpenGraph tags for social sharing"

Performance Improvement:

"Analyze my website's page speed"
"Check technical SEO issues"
"Identify critical problems affecting my rankings"

Competitive Analysis:

"Perform enterprise SEO analysis comparing my site with competitors"
"Identify content gaps in my industry"
"Find opportunities to outperform competitors"

🔧 Troubleshooting

Common Issues and Solutions

Action Not Working
- Issue: CopilotKit action fails to execute
- Solution: Check your internet connection and try again
- Alternative: Use a different action or rephrase your request
Slow Response Times
- Issue: Actions take too long to complete
- Solution: Wait for completion or try a simpler request
- Alternative: Use the dashboard for quick insights
Incomplete Results
- Issue: Action results are incomplete or unclear
- Solution: Ask for clarification or more details
- Alternative: Try a different action or rephrase your question
Technical Errors
- Issue: Error messages or technical problems
- Solution: Refresh the page and try again
- Alternative: Contact support if the issue persists

Getting Help

Ask for Clarification: If you don't understand a result, ask the AI to explain
Request Examples: Ask for specific examples or step-by-step instructions
Use Different Actions: Try alternative actions to get the information you need
Contact Support: Reach out to the support team for technical issues

❓ FAQ

General Questions

Q: How accurate are the SEO CopilotKit results? A: The results are based on industry-standard SEO best practices and real-time data analysis. However, SEO is complex, so always use the recommendations as guidance and test changes carefully.

Q: How often should I use SEO CopilotKit? A: We recommend using it weekly for regular monitoring and monthly for comprehensive audits. Use it whenever you make significant changes to your website.

Q: Can I use SEO CopilotKit for multiple websites? A: Yes, you can analyze multiple websites by providing different URLs for each action.

Q: Are the recommendations actionable? A: Yes, all recommendations include specific, actionable steps you can take to improve your SEO.

Technical Questions

Q: What data does SEO CopilotKit use? A: It uses your website's public data, search engine data, and industry benchmarks to provide analysis and recommendations.

Q: How secure is my data? A: Your data is processed securely and is not shared with third parties. We follow industry-standard security practices.

Q: Can I export the results? A: Yes, you can export analysis results and reports for your records or to share with your team.

Q: Does SEO CopilotKit integrate with other tools? A: Currently, it works within the ALwrity platform. Future integrations may be available.

SEO Questions

Q: How long does it take to see SEO improvements? A: SEO improvements typically take 3-6 months to show results, but some technical fixes can show immediate improvements.

Q: Should I implement all recommendations at once? A: No, implement changes gradually and monitor the impact. Start with critical issues first.

Q: How do I know if the changes are working? A: Use the dashboard actions to track your progress and monitor key metrics over time.

Q: What if I disagree with a recommendation? A: SEO CopilotKit provides guidance based on best practices, but you should always consider your specific situation and consult with your team.

📞 Support

Getting Help

In-App Help: Use the help feature within the CopilotKit interface
Documentation: Refer to this user guide for detailed information
Support Team: Contact our support team for technical issues
Community: Join our user community for tips and best practices

Feedback

We value your feedback! Please share your experience with SEO CopilotKit to help us improve the service.

🎉 Congratulations! You're now ready to use ALwrity SEO CopilotKit effectively. Start exploring the features and watch your SEO performance improve!

25 KiB Raw Blame History

ALwrity SEO CopilotKit User Guide

Complete Guide to AI-Powered SEO Optimization

📋 Table of Contents

🚀 Getting Started

What is SEO CopilotKit?

How to Access SEO CopilotKit

Basic Interaction

🤖 Understanding CopilotKit

How It Works

Available Context

Response Types

🔍 SEO Analysis Actions

1. Comprehensive SEO Analysis

2. SEO Health Check

📝 Content Optimization Actions

3. Meta Description Generation

4. Image Alt Text Generation

5. OpenGraph Tag Generation

6. Content Analysis

⚙️ Technical SEO Actions

7. Page Speed Analysis

8. Sitemap Analysis

9. Technical SEO Analysis

10. On-Page SEO Analysis

🏢 Advanced SEO Actions

11. Enterprise SEO Analysis

12. Content Strategy Analysis

13. Website Audit

📊 Dashboard & Visualization Actions

14. Update SEO Charts

15. Customize SEO Dashboard

16. SEO Concept Explanation

🎯 Best Practices

Getting the Most from SEO CopilotKit

Common Use Cases

🔧 Troubleshooting

Common Issues and Solutions

Getting Help

❓ FAQ

General Questions

Technical Questions

SEO Questions

📞 Support

Getting Help

Feedback

25 KiB

Raw Blame History