docs & ux improvmeents

This commit is contained in:
IGNY8 VPS (Salman)
2025-12-25 20:31:58 +00:00
parent 90e6e96b2b
commit 4bffede052
247 changed files with 6869 additions and 53517 deletions

223
IGNY8-APP.md Normal file
View File

@@ -0,0 +1,223 @@
# IGNY8 - AI-Powered SEO Content Platform
**Version:** 1.0.5
**Last Updated:** December 25, 2025
**Status:** Production Ready
---
## What is IGNY8?
IGNY8 is an enterprise-grade AI-powered content platform that helps businesses create, manage, and publish SEO-optimized content at scale. It combines artificial intelligence with workflow automation to transform keyword research into published articles with minimal manual effort.
---
## Platform Overview
| Aspect | Details |
|--------|---------|
| Type | Full-stack SaaS Platform |
| Architecture | Multi-tenant cloud application |
| Target Users | Content marketers, SEO agencies, digital publishers |
| Deployment | Docker-based, cloud-hosted |
| Pricing | Credit-based usage with subscription plans |
---
## Core Capabilities
### 1. AI Content Generation
Transform keywords into fully-formed, SEO-optimized articles:
- **GPT-4 Powered Writing**: High-quality, contextually-aware content
- **Smart Structuring**: Proper headings, paragraphs, lists automatically
- **SEO Optimization**: Meta titles, descriptions, keyword density
- **Customizable Length**: 500 to 5,000+ words per article
- **Multiple Content Types**: Blog posts, guides, comparisons, reviews
### 2. Intelligent Keyword Management
Comprehensive keyword research and organization:
- **Bulk Import**: Upload thousands of keywords via CSV
- **AI Clustering**: Automatically group related keywords
- **Global Database**: 50+ industries with seed keywords
- **Intent Classification**: Informational, commercial, transactional
- **Metrics Tracking**: Volume, difficulty, CPC
### 3. Content Idea Generation
Transform clusters into actionable content briefs:
- **AI-Powered**: Generate ideas from keyword clusters
- **Structured Briefs**: Title, keywords, angle, outline
- **Word Count Estimates**: Based on competition analysis
- **Priority Scoring**: Rank by SEO potential
### 4. Image Generation
Dual AI providers for visual content:
- **DALL-E 3**: High-quality image generation
- **Runware**: Alternative provider for variety
- **Smart Prompts**: Extracted from content context
- **Multiple Types**: Featured, in-article, mobile/desktop
### 5. Automation Pipeline
Complete 7-stage automated workflow:
```
Keywords → Clusters → Ideas → Tasks → Content → Image Prompts → Images
```
- **Scheduled Runs**: Daily, weekly, or monthly
- **Configurable**: Batch sizes, delays, stages
- **Credit Estimation**: Know costs before running
- **Pause/Resume**: Control running automation
### 6. WordPress Integration
Seamless publishing to WordPress:
- **One-Click Publish**: Push content directly
- **Two-Way Sync**: Import and export content
- **Taxonomy Sync**: Categories and tags
- **Image Upload**: Featured and in-article
- **Multiple Sites**: Manage many WordPress sites
---
## Module Status
| Module | Status | Description |
|--------|--------|-------------|
| **Planner** | ✅ Active | Keyword management, clustering, ideas |
| **Writer** | ✅ Active | Task management, content generation, images |
| **Automation** | ✅ Active | 7-stage automated pipeline |
| **Billing** | ✅ Active | Credits, plans, payments |
| **Integrations** | ✅ Active | WordPress sync |
| **Settings** | ✅ Active | AI config, prompts, modules |
| **Publisher** | ✅ Active | Publishing pipeline |
| **Linker** | ⏸️ Inactive | Internal linking (available but disabled) |
| **Optimizer** | ⏸️ Inactive | Content optimization (available but disabled) |
---
## Plans & Pricing
### Subscription Plans
| Plan | Sites | Users | Credits/Month | Best For |
|------|-------|-------|---------------|----------|
| Free | 1 | 1 | 100 | Trial |
| Starter | 3 | 3 | 1,000 | Individuals |
| Growth | 10 | 10 | 5,000 | Small teams |
| Scale | Unlimited | Unlimited | 25,000 | Agencies |
### Credit Costs (Typical)
| Operation | Credits |
|-----------|---------|
| Keyword Clustering (batch) | 10 |
| Content Idea | 2 |
| Content (per 100 words) | 5 |
| Image (basic) | 3 |
| Image (premium) | 5 |
---
## User Roles
| Role | Access Level |
|------|--------------|
| Admin | Full account access |
| Manager | Content + billing view |
| Editor | AI content, clusters, tasks |
| Viewer | Read-only dashboards |
---
## Key Workflows
### Manual Content Creation
1. Import keywords or select from database
2. Run AI clustering to group keywords
3. Generate content ideas from clusters
4. Create tasks from ideas
5. Generate content with AI
6. Generate images for content
7. Review and edit
8. Publish to WordPress
### Automated Content Pipeline
1. Configure automation settings
2. Set schedule (daily/weekly/monthly)
3. System runs 7 stages automatically
4. Content queued for review
5. Approve and publish
---
## Security & Compliance
- Encrypted data at rest and in transit
- Multi-tenant data isolation
- Role-based access control
- Session management with Redis
- GDPR compliance ready
---
## Current Limitations
| Item | Status |
|------|--------|
| Stripe payments | Pending production credentials |
| PayPal payments | Pending production credentials |
| Linker module | Disabled by default |
| Optimizer module | Disabled by default |
---
## Technical Details
For technical documentation, see: `/docs/INDEX.md`
| Component | Technology |
|-----------|------------|
| Backend | Django 5.x, Python |
| Frontend | React 19, TypeScript |
| Database | PostgreSQL |
| Cache | Redis |
| AI | OpenAI GPT-4, DALL-E 3 |
| Deployment | Docker |
---
## Support & Resources
| Resource | Location |
|----------|----------|
| Technical Docs | `/docs/INDEX.md` |
| API Reference | `/docs/20-API/ENDPOINTS.md` |
| Changelog | `/CHANGELOG.md` |
| Rules | `/RULES.md` |
---
## Version History
- **v1.0.5** (Dec 12, 2025): Purchase Credits tab, UI reorganization
- **v1.0.4** (Dec 12, 2025): Credit Activity tab, Cost Reference panel
- **v1.0.3** (Dec 12, 2025): Usage Limits colors, Cost Breakdown
- **v1.0.2** (Dec 12, 2025): Design system enforcement
- **v1.0.1** (Dec 12, 2025): Plan limits UI
- **v1.0.0** (Dec 12, 2025): Initial production release
---
*This document provides a non-technical overview. For technical implementation details, refer to the docs folder.*