Files
ALwrity/docs-site/docs/features/seo-dashboard/index.md
ajaysi 644e72d289 feat: Brainstorm Topics with GSC + Issue #518 fixes + Blog Editor enhancements
Issue #518 - Subscription not updating after checkout:
- Fix stale closure in SubscriptionContext checkout polling (use subscriptionRef)
- Move checkout success polling from InitialRouteHandler into SubscriptionContext
- Remove redundant polling code from InitialRouteHandler
- Fix plan label: 'Free' instead of 'No Plan', proper capitalization
- Add plan refresh button in UserBadge
- Add 'View Costing Details' to UserBadge dropdown
- Rename 'ALwrity Podcast Maker' to 'Podcast Creator' across UI
- Clean subscription=success URL param after verification

Blog Writer WYSIWYG Editor enhancements:
- Per-section preview toggle (view/edit icons)
- Enhanced hover-based toolbar
- Circular SVG progress stats bar with detailed tooltip
- Research tool chips in stats bar footer
- Per-section TTS with useTextToSpeech hook (browser native)
- Full blog preview modal with print/PDF support
- PlayAllTTSButton: sequential playback with progress bar
- OnThisPageNav: floating sidebar with scroll tracking
- Section data attributes for scroll anchoring

GSC Brainstorm Topics feature:
- Backend: gsc_brainstorm_service.py (rule-based + LLM recommendations)
- Backend: POST /gsc/brainstorm endpoint with 3-word minimum validation
- Frontend: gscBrainstorm.ts API client
- Frontend: useGSCBrainstormConnection hook (popup OAuth, no /onboarding redirect)
- Frontend: useGSCBrainstorm hook (connect check + brainstorm call)
- Frontend: GSCBrainstormModal (3-tab results: Opportunities, Gaps, AI Recs)
- Frontend: BrainstormButton (visible at 3+ words, GSC connect overlay)
- Wire BrainstormButton into ManualResearchForm and ResearchAction
- Add blog_writer to gsc_auth router features for ALWRITY_ENABLED_FEATURES
2026-05-20 22:44:15 +05:30

346 lines
11 KiB
Markdown

# SEO Dashboard Complete Documentation Index
Welcome to ALwrity's complete SEO Dashboard documentation. This index helps you find exactly what you need.
---
## 📚 Find What You Need
### 🆕 Just Getting Started?
Start here to get up and running quickly:
- **[Quick Start Guide](quick-start.md)** - Get optimizing in 10 minutes
- **[Overview](overview.md)** - Understand the dashboard
- **[Tools Reference](tools-reference.md)** - See all 21 tools at a glance
### 🛠️ Want to Learn Individual Tools?
Each tool has a detailed guide:
- **[Individual Tools Guide](individual-tools-guide.md)** - Complete guide to all 9 core tools:
- Meta Description Generator
- PageSpeed Analyzer
- Sitemap Analyzer
- Image Alt Text Generator
- OpenGraph Generator
- On-Page SEO Analyzer
- Technical SEO Analyzer
- Enterprise SEO Suite
- Content Strategy Analyzer
### 📋 Ready to Create Workflows?
Learn proven workflows and processes:
- **[Workflows & Automation Guide](workflows-guide.md)** - 10+ real-world workflows:
- Content Creation Pipeline
- Website Audit & Improvement
- Performance Optimization
- Monthly SEO Maintenance
- Industry-Specific Workflows
- Quick Wins Strategy
- Collaborative Team Workflows
- Time-Based Workflows
### 🤖 Want AI Recommendations?
Get strategic help from our AI:
- **[AI Copilot Guide](ai-copilot.md)** - Learn to use conversational AI:
- How to ask for recommendations
- Content strategy help
- Tool usage guidance
- Problem solving with AI
- Example conversations
- Advanced use cases
### 🏆 Doing Competitive Research?
Benchmark against competitors:
- **[Competitive Analysis Guide](competitive-analysis.md)** - Understand your market:
- Competitor discovery
- Content benchmarking
- Technical comparison
- Opportunity identification
- Market positioning strategies
- Differentiation tactics
### 📝 Planning Content Strategy?
Find content opportunities and plan:
- **[Content Strategy Guide](content-strategy-guide.md)** - Plan your content:
- Finding content gaps
- Scoring opportunities
- Building content clusters
- Planning publishing calendar
- Measuring ROI
### 🏷️ Learning About Metadata?
Master SEO metadata:
- **[Metadata Generation Guide](metadata.md)** - Complete metadata reference:
- Meta descriptions
- OpenGraph tags
- Title tag optimization
- Twitter cards
- Schema markup
- Structured data
### 🔗 Need GSC Integration Info?
Connect your Google Search Console:
- **[GSC Integration Guide](gsc-integration.md)** - Setup and usage
### 📐 Want Technical Details?
Deep technical reference:
- **[Design Document](design-document.md)** - Architecture and technical specs
---
## 📖 Documentation by Use Case
### For Content Creators
**Goal**: Create great content that ranks
**Recommended Reading Order**:
1. [Quick Start Guide](quick-start.md) - 10 min
2. [Meta Description Generator](individual-tools-guide.md#1--meta-description-generator) - 5 min
3. [On-Page SEO Analyzer](individual-tools-guide.md#6--on-page-seo-analyzer) - 10 min
4. [Content Strategy Analyzer](individual-tools-guide.md#9--content-strategy-analyzer) - 10 min
5. [Content Creation Workflow](workflows-guide.md#workflow-1-content-creation-pipeline) - 5 min
**Total Learning Time**: 40 minutes
**First Task**: Create one optimized article
---
### For Digital Marketers
**Goal**: Improve organic traffic and rankings
**Recommended Reading Order**:
1. [Quick Start Guide](quick-start.md) - 10 min
2. [Tools Reference](tools-reference.md) - 15 min
3. [Competitive Analysis Guide](competitive-analysis.md) - 20 min
4. [Content Strategy Guide](content-strategy-guide.md) - 30 min
5. [Workflows & Automation](workflows-guide.md) - 30 min
**Total Learning Time**: 1.5-2 hours
**First Task**: Run competitive analysis
---
### For SEO Professionals
**Goal**: Comprehensive SEO optimization
**Recommended Reading Order**:
1. [Overview](overview.md) - 10 min
2. [Tools Reference](tools-reference.md) - 20 min
3. [Individual Tools Guide](individual-tools-guide.md) - 45 min
4. [Workflows & Automation](workflows-guide.md) - 45 min
5. [Competitive Analysis Guide](competitive-analysis.md) - 30 min
6. [Content Strategy Guide](content-strategy-guide.md) - 30 min
7. [Design Document](design-document.md) - 15 min
**Total Learning Time**: 3-4 hours
**First Task**: Run Enterprise SEO Suite audit
---
### For Developers/Technical Teams
**Goal**: Ensure technical SEO health
**Recommended Reading Order**:
1. [Quick Start Guide](quick-start.md) - 10 min
2. [Technical SEO Analyzer](individual-tools-guide.md#7--technical-seo-analyzer) - 15 min
3. [PageSpeed Analyzer](individual-tools-guide.md#2--pagespeed-analyzer) - 15 min
4. [Design Document](design-document.md) - 20 min
**Total Learning Time**: 1 hour
**First Task**: Run Technical SEO audit on website
---
### For Solopreneurs
**Goal**: Quick wins with minimal time
**Recommended Reading Order**:
1. [Quick Start Guide](quick-start.md) - 10 min
2. [Quick Wins Workflow](workflows-guide.md#quick-wins-workflow) - 5 min
3. [Individual Tools Guide](individual-tools-guide.md#choosing-the-right-tool) - 10 min
**Total Learning Time**: 25 minutes
**First Task**: Complete quick wins (5-day plan)
---
## 🎯 Quick Tool Selection Guide
### By Time Available
**I have 5 minutes:**
- Use: Meta Description Generator
- Run on: Homepage
- Expected result: Updated meta descriptions
**I have 15 minutes:**
- Use: On-Page SEO Analyzer
- Run on: Top 3 pages
- Expected result: Optimization checklist
**I have 30 minutes:**
- Use: PageSpeed Analyzer + On-Page SEO
- Run on: Top 5 pages
- Expected result: Performance baseline + optimization plan
**I have 1 hour:**
- Use: Technical SEO Analyzer + Content Strategy
- Run on: Entire site + top opportunities
- Expected result: Technical issues + content plan
**I have 2+ hours:**
- Use: Enterprise SEO Suite + Competitive Analysis
- Run on: Full website audit
- Expected result: Comprehensive report + strategy
---
### By Goal
| Goal | Tool | Guide |
|------|------|-------|
| Quick content optimization | On-Page SEO Analyzer | [Link](individual-tools-guide.md#6--on-page-seo-analyzer) |
| Improve search appearance | Meta Description Generator | [Link](individual-tools-guide.md#1--meta-description-generator) |
| Social media optimization | OpenGraph Generator | [Link](individual-tools-guide.md#5--opengraph-generator) |
| Find new content ideas | Content Strategy Analyzer | [Link](individual-tools-guide.md#9--content-strategy-analyzer) |
| Fix website speed | PageSpeed Analyzer | [Link](individual-tools-guide.md#2--pagespeed-analyzer) |
| Find technical issues | Technical SEO Analyzer | [Link](individual-tools-guide.md#7--technical-seo-analyzer) |
| Understand your site | Sitemap Analyzer | [Link](individual-tools-guide.md#3--sitemap-analyzer) |
| Optimize images | Image Alt Text Generator | [Link](individual-tools-guide.md#4--image-alt-text-generator) |
| Complete audit | Enterprise SEO Suite | [Link](individual-tools-guide.md#8--enterprise-seo-suite) |
| Beat competitors | Competitive Analysis | [Link](competitive-analysis.md) |
| Plan strategy | Content Strategy Guide | [Link](content-strategy-guide.md) |
| AI recommendations | AI Copilot | [Link](ai-copilot.md) |
---
## 📊 Quick Stats
### Available Tools
- **9 Individual SEO Analysis Tools**
- **12 Dashboard & Integration Tools**
- **3+ Workflow Templates**
- **21 Total Functional Tools**
### Documentation Coverage
- **11 Comprehensive Guides**
- **50+ Pages of Documentation**
- **1000+ Real-World Examples**
- **100+ Best Practices**
- **10+ Complete Workflows**
### Learning Resources
- Quick Start: 10 minutes
- Individual Tool Guides: 45 minutes
- Workflow Guides: 45 minutes
- Complete Learning: 3-4 hours
---
## 🚀 Getting Started Now
### Path 1: Quick Start (10 minutes)
```
Read: Quick Start Guide
Run: One tool analysis
Expected Result: First optimization
```
### Path 2: Smart Start (1 hour)
```
Read: Overview → Individual Tools Guide (choose 2-3)
Run: On-Page SEO + One more tool
Expected Result: Clear improvement plan
```
### Path 3: Deep Dive (3-4 hours)
```
Read: Complete documentation
Run: Multiple tool analyses
Expected Result: Comprehensive strategy
```
---
## 🔗 Navigation
### All Guides at a Glance
**User Guides:**
- [Quick Start](quick-start.md) - New user orientation
- [Overview](overview.md) - Dashboard overview
- [Individual Tools Guide](individual-tools-guide.md) - Tool details
**Strategy Guides:**
- [Content Strategy Guide](content-strategy-guide.md) - Content planning
- [Competitive Analysis](competitive-analysis.md) - Market research
- [AI Copilot Guide](ai-copilot.md) - AI assistant usage
**Implementation Guides:**
- [Workflows & Automation](workflows-guide.md) - Proven workflows
- [Metadata Generation](metadata.md) - Meta tag optimization
**Reference:**
- [Tools Reference](tools-reference.md) - Complete tool inventory
- [Design Document](design-document.md) - Technical reference
- [GSC Integration](gsc-integration.md) - Platform integration
---
## ❓ Common Questions
**Q: Where do I start?**
A: See [Quick Start Guide](quick-start.md)
**Q: How do I choose a tool?**
A: See [Tools Reference](tools-reference.md) or use the tool selection guide above
**Q: What's the best workflow for my situation?**
A: See [Workflows & Automation](workflows-guide.md)
**Q: How long until I see results?**
A: Typically 4-8 weeks for ranking changes. See [Quick Start FAQ](quick-start.md#common-questions-for-beginners)
**Q: How often should I run analyses?**
A: See [Individual Tools Guide](individual-tools-guide.md#quick-reference) for recommended frequency
**Q: Can I get AI help?**
A: Yes! See [AI Copilot Guide](ai-copilot.md)
---
## 📞 Need More Help?
1. **Check this index** - You probably found what you need
2. **Ask AI Copilot** - Use the chat in your dashboard
3. **Review relevant guide** - Each guide has detailed examples
4. **Check Tools Reference** - Complete tool specifications
---
## 📈 What You'll Accomplish
After using these guides, you'll be able to:
- ✅ Understand all 21 SEO tools available
- ✅ Optimize pages for better rankings
- ✅ Create content strategy
- ✅ Find competitive opportunities
- ✅ Implement proven workflows
- ✅ Measure and track improvements
- ✅ Get AI recommendations
- ✅ Scale your SEO efforts
---
## 🎯 Ready to Start?
1. **New User?** → Start with [Quick Start Guide](quick-start.md)
2. **Ready to Optimize?** → Choose a tool from [Tools Reference](tools-reference.md)
3. **Want Strategy?** → Read [Content Strategy Guide](content-strategy-guide.md)
4. **Need Workflows?** → Check [Workflows & Automation](workflows-guide.md)
---
**Let's start optimizing! 🚀**
Pick your starting point above and begin your SEO journey.