Remove obsolete migration and workflow files; delete Site Builder Wizard references and related components. Update documentation to reflect the removal of the WorkflowState model and streamline the site building process.
This commit is contained in:
IGNY8 VPS (Salman)
@@ -1,6 +1,6 @@
|
||||
# IGNY8 Functional Business Logic Documentation
|
||||
|
||||
**Last Updated:** 2025-01-XX
|
||||
**Last Updated:** 2025-01-XX (Workflow updated - Wizard removed)
|
||||
**Purpose:** Complete functional and business logic documentation covering all workflows, functions, features, and how the application works from a business perspective.
|
||||
|
||||
---
|
||||
@@ -9,17 +9,18 @@
|
||||
|
||||
1. [Prerequisites](#prerequisites)
|
||||
2. [System Overview](#system-overview)
|
||||
3. [Account and User Management](#account-and-user-management)
|
||||
4. [Planner Module - Complete Workflows](#planner-module---complete-workflows)
|
||||
5. [Writer Module - Complete Workflows](#writer-module---complete-workflows)
|
||||
6. [Thinker Module - Complete Workflows](#thinker-module---complete-workflows)
|
||||
7. [System Module - Complete Workflows](#system-module---complete-workflows)
|
||||
8. [Billing Module - Complete Workflows](#billing-module---complete-workflows)
|
||||
9. [AI Functions - Complete Details](#ai-functions---complete-details)
|
||||
10. [Credit System - How It Works](#credit-system---how-it-works)
|
||||
11. [WordPress Integration](#wordpress-integration)
|
||||
12. [Data Flow and State Management](#data-flow-and-state-management)
|
||||
13. [Complete Feature List](#complete-feature-list)
|
||||
3. [Complete User Workflow](#complete-user-workflow)
|
||||
4. [Account and User Management](#account-and-user-management)
|
||||
5. [Planner Module - Complete Workflows](#planner-module---complete-workflows)
|
||||
6. [Writer Module - Complete Workflows](#writer-module---complete-workflows)
|
||||
7. [Thinker Module - Complete Workflows](#thinker-module---complete-workflows)
|
||||
8. [System Module - Complete Workflows](#system-module---complete-workflows)
|
||||
9. [Billing Module - Complete Workflows](#billing-module---complete-workflows)
|
||||
10. [AI Functions - Complete Details](#ai-functions---complete-details)
|
||||
11. [Credit System - How It Works](#credit-system---how-it-works)
|
||||
12. [WordPress Integration](#wordpress-integration)
|
||||
13. [Data Flow and State Management](#data-flow-and-state-management)
|
||||
14. [Complete Feature List](#complete-feature-list)
|
||||
|
||||
---
|
||||
|
||||
@@ -83,6 +84,156 @@ IGNY8 is a SaaS platform for SEO keyword management and AI-driven content genera
|
||||
|
||||
---
|
||||
|
||||
## Complete User Workflow
|
||||
|
||||
### Current Workflow Path (Updated 2025-01-XX)
|
||||
|
||||
The Site Builder Wizard has been removed. The workflow now follows a direct path:
|
||||
|
||||
```
|
||||
PLANNING → WRITER → OPTIMIZE → PUBLISH
|
||||
```
|
||||
|
||||
**Direct Path:** Keywords/Clusters → Ideas → Tasks → Content (no wizard intermediary)
|
||||
|
||||
### Phase Flow Summary
|
||||
|
||||
```
|
||||
┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐
|
||||
│ PLANNING │ --> │ WRITER │ --> │OPTIMIZE │ --> │ PUBLISH │
|
||||
│ │ │ │ │ │ │ │
|
||||
│Keywords │ │Content │ │Link & │ │Deploy │
|
||||
│Clusters │ │Generate │ │Optimize │ │Site │
|
||||
│ Ideas │ │ Images │ │ │ │ │
|
||||
└──────────┘ └──────────┘ └──────────┘ └──────────┘
|
||||
```
|
||||
|
||||
### Complete Workflow Steps
|
||||
|
||||
#### Phase 1: Planning & Keyword Research
|
||||
|
||||
1. **Keyword Discovery**
|
||||
- Navigate to `/planner/keyword-opportunities`
|
||||
- Browse keyword database
|
||||
- Identify target keywords
|
||||
|
||||
2. **Keyword Import**
|
||||
- Navigate to `/planner/keywords`
|
||||
- Import CSV or manual entry
|
||||
- Keywords stored by sector
|
||||
|
||||
3. **Keyword Clustering**
|
||||
- Select keywords → "Auto-Cluster"
|
||||
- AI clustering (1 credit per 30 keywords)
|
||||
- Clusters created automatically
|
||||
|
||||
4. **Cluster Management**
|
||||
- Navigate to `/planner/clusters`
|
||||
- Review & refine clusters
|
||||
- Merge/split clusters as needed
|
||||
- Clusters ready for content generation
|
||||
|
||||
5. **Content Ideas Generation**
|
||||
- Navigate to `/planner/ideas`
|
||||
- Generate ideas from clusters (1 credit per idea)
|
||||
- Review and refine ideas
|
||||
- Queue ideas to Writer
|
||||
|
||||
#### Phase 2: Content Creation (Writer)
|
||||
|
||||
1. **Task Creation**
|
||||
- Ideas automatically create tasks
|
||||
- Navigate to `/writer/tasks`
|
||||
- Review tasks from ideas
|
||||
|
||||
2. **Content Generation**
|
||||
- Select tasks → "Generate Content"
|
||||
- AI content generation (3 credits per content)
|
||||
- HTML content with structured blocks
|
||||
- Meta tags automatically generated
|
||||
|
||||
3. **Content Review**
|
||||
- Navigate to `/writer/content`
|
||||
- Review & edit HTML content
|
||||
- Update metadata (title, description, keywords)
|
||||
- Validate content structure
|
||||
|
||||
4. **Image Generation**
|
||||
- Navigate to `/writer/images`
|
||||
- Generate image prompts (optional)
|
||||
- Generate images (1 credit per image)
|
||||
- Featured and in-article images
|
||||
|
||||
#### Phase 3: Optimization & Linking
|
||||
|
||||
1. **Internal Linking**
|
||||
- Navigate to `/linker/content`
|
||||
- System analyzes content
|
||||
- Suggests internal links (cluster matches prioritized)
|
||||
- Accept/reject link suggestions
|
||||
|
||||
2. **Content Optimization**
|
||||
- Navigate to `/optimizer/content`
|
||||
- System scores content
|
||||
- Review optimization suggestions
|
||||
- Apply improvements
|
||||
|
||||
#### Phase 4: Publishing
|
||||
|
||||
1. **Content Validation**
|
||||
- Navigate to `/sites/:id/posts/:postId`
|
||||
- Validate entity type, cluster mapping, taxonomy
|
||||
- Ensure all attributes complete
|
||||
|
||||
2. **WordPress Publishing**
|
||||
- Select content → "Publish to WordPress"
|
||||
- System validates WordPress connection
|
||||
- Content published to WordPress site
|
||||
- Images uploaded and linked
|
||||
|
||||
3. **Site Deployment** (for IGNY8-hosted sites)
|
||||
- Navigate to `/sites/:id/deploy`
|
||||
- Review cluster coverage
|
||||
- Validate content completeness
|
||||
- Deploy site to sites.igny8.com/{slug}
|
||||
|
||||
### Workflow Variations
|
||||
|
||||
#### Workflow A: New IGNY8-Hosted Site
|
||||
- Complete build from scratch
|
||||
- Full workflow: Planning → Writer → Optimize → Publish → Deploy
|
||||
|
||||
#### Workflow B: Existing Site Management
|
||||
- Add new content to existing site
|
||||
- Manage existing content
|
||||
- Update and republish content
|
||||
|
||||
#### Workflow C: WordPress Sync - New Site
|
||||
- Connect new WordPress site
|
||||
- Sync existing content
|
||||
- Continue with normal workflow
|
||||
|
||||
#### Workflow D: WordPress Sync - Existing Site
|
||||
- Connect existing WordPress site
|
||||
- Import existing posts
|
||||
- Sync and manage content
|
||||
|
||||
### Site Builder Status
|
||||
|
||||
**Removed Features:**
|
||||
- ❌ Site Builder Wizard (6-step guided process)
|
||||
- ❌ WorkflowState model and services
|
||||
- ❌ Wizard UI components and routes
|
||||
|
||||
**Available Features:**
|
||||
- ✅ Site Blueprint APIs (create/manage via API)
|
||||
- ✅ Site Builder models (SiteBlueprint, PageBlueprint, etc.)
|
||||
- ✅ Direct workflow path (Planning → Writer)
|
||||
|
||||
**Note:** Site blueprints can still be created and managed through API endpoints, but there is no guided UI wizard. Users proceed directly from Planning to Writer.
|
||||
|
||||
---
|
||||
|
||||
## Account and User Management
|
||||
|
||||
### Account Creation and Setup
|
||||
|
||||
Reference in New Issue
Block a user