Platform Documentation

Welcome to the ContentGlowz platform. This documentation will help you connect your website, understand the analysis tools, and automate your SEO workflow.


🚀 Quick Start

⚡ Resilience

ContentGlowz is usable during short backend disruptions. If API connectivity is interrupted, the app continues to show available cached data and stores supported edits in a local queue. When the API recovers, queued actions are replayed automatically.

1. Connect Your Website (5 minutes)

Link your GitHub repository to start analyzing your content:

# Start onboarding
curl -X POST https://api.contentglowz.com/api/projects/onboard \
  -H "Content-Type: application/json" \
  -d '{"github_url": "https://github.com/you/your-site"}'

Full Guide: Connect Your Website →

2. Run Your First Analysis (2 minutes)

Once connected, analyze your topical mesh:

curl -X POST https://api.contentglowz.com/api/mesh/analyze \
  -H "Content-Type: application/json" \
  -d '{"repo_url": "https://github.com/you/your-site"}'

3. Get Recommendations

The platform returns:

  • Authority Score (0-100) - How strong is your topical coverage
  • Content Gaps - Topics your competitors cover that you don’t
  • Linking Recommendations - Internal links to add
  • Quick Wins - Immediate actions to improve rankings

📚 Documentation

Getting Started

GuideDescriptionTime
Connect Your WebsiteLink your GitHub repo and configure settings5 min
SEO DeploymentRun SEO pipelines from the dashboard10 min
Image OptimizationGenerate and optimize images for your content5 min
Social ListeningDiscover trending topics from Reddit, X, HN, YouTube5 min
Content Quality ScoringReadability metrics and quality grades5 min
Link PreviewsOpenGraph extraction for your content calendar2 min
Understanding Your AnalysisWhat the scores and metrics mean10 min
API ReferenceComplete API endpoint documentationReference

Core Features

FeatureWhat It Does
Project OnboardingAuto-detects your framework, package manager, and content structure
Topical Mesh AnalysisMaps your internal linking and calculates authority scores
Content Gap AnalysisCompares your content against competitors
SEO RecommendationsPrioritized actions to improve rankings
SEO DeploymentRun content pipelines, batch process topics, schedule automation
Image OptimizationGenerate hero images, social cards, and responsive variants via global CDN
Cookie-Free AnalyticsBuilt-in pageview tracking — no cookies, no consent banner, EU-hosted, under 1KB script
Social ListeningScan Reddit, X, HN, and YouTube for trending topics — auto-ranks by engagement and cross-platform convergence
Content Quality Scoring6 readability metrics (Flesch, Gunning Fog, SMOG…) with letter grades — catches hard-to-read content before publication
Link PreviewsInstant OpenGraph extraction — see titles, descriptions, and images for any URL in your calendar

🔧 Supported Frameworks

The platform auto-detects and optimizes for:

FrameworkDetectionContent Conventions
Astroastro.config.mjssrc/content/, src/pages/
Next.jsnext.config.jscontent/, posts/, app/
Gatsbygatsby-config.jscontent/, src/pages/
Nuxtnuxt.config.jscontent/, pages/
Hugohugo.tomlcontent/
Jekyll_config.yml_posts/, _pages/

Package Managers

Automatically detected from lock files:

  • pnpmpnpm-lock.yaml
  • yarnyarn.lock
  • npmpackage-lock.json

🎯 Platform Workflow

┌─────────────────────────────────────────────────────────────┐
│                   CONTENTGLOWZ WORKFLOW                      │
├─────────────────────────────────────────────────────────────┤
│                                                             │
│  1. CONNECT                                                 │
│     └─→ Add your GitHub repo URL                           │
│     └─→ Platform clones and analyzes structure             │
│     └─→ Auto-detects framework & content directories       │
│                                                             │
│  2. ANALYZE                                                 │
│     └─→ Maps all your content pages                        │
│     └─→ Calculates topical authority (0-100)               │
│     └─→ Identifies orphan pages and weak links             │
│                                                             │
│  3. CREATE & OPTIMIZE                                       │
│     └─→ Generate SEO-optimized content                     │
│     └─→ Create professional images automatically           │
│     └─→ Deliver via global CDN for speed                   │
│                                                             │
│  4. MONITOR                                                 │
│     └─→ Track authority score over time                    │
│     └─→ Get alerts on ranking changes                      │
│     └─→ Automated content suggestions                      │
│                                                             │
└─────────────────────────────────────────────────────────────┘

📊 What You Get

Topical Authority Score

Your overall SEO strength on a topic:

GradeScoreMeaning
A85-100Excellent - Industry leading coverage
B70-84Good - Competitive position
C55-69Fair - Room for improvement
D40-54Poor - Significant gaps
F0-39Very Poor - Major work needed

Mesh Density

How well your pages link to each other:

Density = Actual Internal Links / Possible Links

0.50+ = Strong mesh (excellent)
0.40-0.49 = Good mesh
0.30-0.39 = Adequate mesh
<0.30 = Weak mesh (needs work)

Actionable Recommendations

Every analysis includes:

  • Quick Wins - Changes you can make today
  • Content Gaps - Topics to write about
  • Link Suggestions - Specific pages to connect
  • Priority Ranking - What to do first

🔌 Integration Options

REST API

Full programmatic access:

import httpx

# Analyze your site
response = httpx.post(
    "https://api.contentglowz.com/api/mesh/analyze",
    json={"repo_url": "https://github.com/you/your-site"},
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)

analysis = response.json()
print(f"Authority Score: {analysis['authority_score']}/100")

Dashboard

Visual interface for:

  • Project management and robot monitoring
  • SEO Deployment - Run pipelines, batch processing, scheduling
  • Analysis history and log viewing
  • Recommendation tracking

CI/CD Integration

Add to your deployment pipeline:

# .github/workflows/seo-check.yml
- name: SEO Analysis
  run: |
    curl -X POST https://api.contentglowz.com/api/mesh/analyze \
      -H "Authorization: Bearer ${{ secrets.SEO_API_KEY }}" \
      -d '{"repo_url": "${{ github.repository }}"}'

💬 Need Help?

Resources

Support


Last updated: March 30, 2026