# IGNY8 Technical Documentation

**Version:** 1.2.0  
**Last Updated:** December 27, 2025  
**Purpose:** Complete technical reference for the IGNY8 AI content platform

---

## Quick Navigation

| I want to... | Go to |
|--------------|-------|
| Understand system architecture | [00-SYSTEM/ARCHITECTURE.md](00-SYSTEM/ARCHITECTURE.md) |
| Work with a specific module | [10-MODULES/](#modules) |
| Find an API endpoint | [20-API/ENDPOINTS.md](20-API/ENDPOINTS.md) |
| Understand frontend structure | [30-FRONTEND/PAGES.md](30-FRONTEND/PAGES.md) |
| Trace a workflow end-to-end | [40-WORKFLOWS/](#workflows) |
| Look up model fields | [90-REFERENCE/MODELS.md](90-REFERENCE/MODELS.md) |
| Troubleshoot issues | [90-REFERENCE/TROUBLESHOOTING.md](90-REFERENCE/TROUBLESHOOTING.md) |
| See known issues | [/PRE-LAUNCH-AUDIT.md](/PRE-LAUNCH-AUDIT.md) |

---

## 00-SYSTEM - Architecture & Core

| Document | Purpose |
|----------|---------|
| [ARCHITECTURE.md](00-SYSTEM/ARCHITECTURE.md) | Tech stack, deployment, system design |
| [AUTH-FLOWS.md](00-SYSTEM/AUTH-FLOWS.md) | Authentication, JWT, sessions, roles |
| [TENANCY.md](00-SYSTEM/TENANCY.md) | Multi-tenant architecture, Account/Site/Sector |

---

## 10-MODULES - Feature Modules {#modules}

| Module | Status | Description | Document |
|--------|--------|-------------|----------|
| **Planner** | ✅ Active | Keywords → Clusters → Ideas | [PLANNER.md](10-MODULES/PLANNER.md) |
| **Writer** | ✅ Active | Tasks → Content → Images | [WRITER.md](10-MODULES/WRITER.md) |
| **Automation** | ✅ Active | 7-stage automated pipeline | [AUTOMATION.md](10-MODULES/AUTOMATION.md) |
| **Billing** | ✅ Active | Credits, plans, payments | [BILLING.md](10-MODULES/BILLING.md) |
| **Integrations** | ✅ Active | WordPress sync, webhooks | [INTEGRATIONS.md](10-MODULES/INTEGRATIONS.md) |
| **Notifications** | ✅ Active | Real-time notifications for AI tasks | [NOTIFICATIONS.md](10-MODULES/NOTIFICATIONS.md) |
| **System** | ✅ Active | Settings, prompts, AI config | [SYSTEM-SETTINGS.md](10-MODULES/SYSTEM-SETTINGS.md) |
| **Publisher** | ✅ Active | Content publishing pipeline | [PUBLISHER.md](10-MODULES/PUBLISHER.md) |
| **Linker** | ⏸️ Inactive | Internal linking (disabled by default) | [LINKER.md](10-MODULES/LINKER.md) |
| **Optimizer** | ⏸️ Inactive | Content optimization (disabled by default) | [OPTIMIZER.md](10-MODULES/OPTIMIZER.md) |

---

## 20-API - REST API Reference

| Document | Purpose |
|----------|---------|
| [ENDPOINTS.md](20-API/ENDPOINTS.md) | Complete endpoint list with methods and handlers |
| [SCHEMAS.md](20-API/SCHEMAS.md) | Request/response examples |

---

## 30-FRONTEND - React Application

| Document | Purpose |
|----------|---------|
| [PAGES.md](30-FRONTEND/PAGES.md) | All pages and routes || [PAGE-REQUIREMENTS.md](30-FRONTEND/PAGE-REQUIREMENTS.md) | Site/sector selector requirements || [STORES.md](30-FRONTEND/STORES.md) | Zustand state management |
| [COMPONENTS.md](30-FRONTEND/COMPONENTS.md) | Key reusable components |

### Current Page Structure (v1.2.0)

```
/                           → Dashboard (Home.tsx) - with new widgets
├── SETUP
│   /setup/add-keywords     → Add Keywords (AddKeywords.tsx)
│   /account/content-settings → Content Settings (ContentSettingsPage.tsx)
│   /sites                  → Sites List (List.tsx)
│   /sites/:id/settings     → Site Settings (SiteSettings.tsx)
│   /thinker/prompts        → Thinker Prompts (Prompts.tsx) [Admin]
│   /thinker/author-profiles → Author Profiles (AuthorProfiles.tsx) [Admin]
├── WORKFLOW
│   /planner/keywords       → Planner Keywords (Keywords.tsx)
│   /planner/clusters       → Clusters (Clusters.tsx)
│   /planner/ideas          → Ideas (Ideas.tsx)
│   /writer/tasks           → Writer Queue (Tasks.tsx)
│   /writer/drafts          → Drafts (Drafts.tsx)
│   /writer/images          → Images (Images.tsx)
│   /writer/review          → Review (Review.tsx)
│   /writer/approved        → Approved (Approved.tsx)
│   /automation             → Automation Dashboard (Dashboard.tsx)
│   /linker/content         → Linker [if enabled]
│   /optimizer/content      → Optimizer [if enabled]
├── ACCOUNT
│   /account/settings       → Account Settings (AccountSettingsPage.tsx)
│                             - Tabs: Account, Profile, Team
│   /account/plans          → Plans & Billing (PlansAndBillingPage.tsx)
│                             - Tabs: Plan, Upgrade, History
│   /account/usage          → Usage Analytics (UsageAnalyticsPage.tsx)
│                             - Tabs: Limits, Credit History, API Activity
│   /settings/integration   → AI Models (IntegrationPage.tsx) [Admin]
└── HELP
    /help                   → Help Center (HelpCenter.tsx)
```

---

## 40-WORKFLOWS - Cross-Module Flows {#workflows}

| Document | Purpose |
|----------|---------|
| [CONTENT-PIPELINE.md](40-WORKFLOWS/CONTENT-PIPELINE.md) | Keyword → Published article flow |
| [CREDIT-DEDUCTION.md](40-WORKFLOWS/CREDIT-DEDUCTION.md) | When and how credits are used |
| [WORDPRESS-SYNC.md](40-WORKFLOWS/WORDPRESS-SYNC.md) | Two-way WordPress synchronization |

---

## 90-REFERENCE - Quick Lookup

| Document | Purpose |
|----------|---------|
| [MODELS.md](90-REFERENCE/MODELS.md) | All database models and fields |
| [AI-FUNCTIONS.md](90-REFERENCE/AI-FUNCTIONS.md) | AI engine capabilities and costs |
| [TROUBLESHOOTING.md](90-REFERENCE/TROUBLESHOOTING.md) | Common issues and fixes |

---

## Root Files

| File | Purpose |
|------|---------|
| [/CHANGELOG.md](/CHANGELOG.md) | Version history and changes |
| [/IGNY8-APP.md](/IGNY8-APP.md) | Platform overview (non-technical) |
| [/PRE-LAUNCH-AUDIT.md](/PRE-LAUNCH-AUDIT.md) | Known issues and improvement roadmap |

---

## Module → File Quick Reference

| Module | Backend Path | Frontend Path |
|--------|--------------|---------------|
| Dashboard | N/A | `frontend/src/pages/Dashboard/` |
| Setup | N/A | `frontend/src/pages/Setup/` |
| Planner | `backend/igny8_core/modules/planner/` | `frontend/src/pages/Planner/` |
| Writer | `backend/igny8_core/modules/writer/` | `frontend/src/pages/Writer/` |
| Billing | `backend/igny8_core/modules/billing/` + `business/billing/` | `frontend/src/pages/account/` |
| Automation | `backend/igny8_core/business/automation/` | `frontend/src/pages/Automation/` |
| Integrations | `backend/igny8_core/modules/integration/` + `business/integration/` | `frontend/src/pages/Settings/` |
| System | `backend/igny8_core/modules/system/` | `frontend/src/pages/Settings/` |
| Linker | `backend/igny8_core/modules/linker/` | `frontend/src/pages/Linker/` |
| Optimizer | `backend/igny8_core/modules/optimizer/` + `business/optimization/` | `frontend/src/pages/Optimizer/` |
| Publisher | `backend/igny8_core/modules/publisher/` + `business/publishing/` | N/A (backend only) |
| Auth | `backend/igny8_core/auth/` | `frontend/src/pages/AuthPages/` |
| AI Engine | `backend/igny8_core/ai/` | N/A |
| Thinker | `backend/igny8_core/modules/thinker/` | `frontend/src/pages/Thinker/` |
| Sites | `backend/igny8_core/modules/sites/` | `frontend/src/pages/Sites/` |
| Help | N/A | `frontend/src/pages/Help/` |
| Account | `backend/igny8_core/modules/accounts/` | `frontend/src/pages/account/` |

---

## API Base Paths

| Module | Base URL |
|--------|----------|
| Auth | `/api/v1/auth/` |
| Planner | `/api/v1/planner/` |
| Writer | `/api/v1/writer/` |
| Billing | `/api/v1/billing/` |
| Integration | `/api/v1/integration/` |
| System | `/api/v1/system/` |
| Linker | `/api/v1/linker/` |
| Optimizer | `/api/v1/optimizer/` |
| Publisher | `/api/v1/publisher/` |

---

## Tech Stack Summary

| Layer | Technology |
|-------|------------|
| Backend | Django 5.x, Django REST Framework, PostgreSQL 15+ |
| Frontend | React 19, TypeScript, Vite, TailwindCSS |
| State | Zustand |
| Async | Celery + Redis |
| AI | OpenAI (GPT-4, GPT-4 Turbo), DALL-E 3, Runware |
| Auth | JWT + Redis Sessions |
| Deployment | Docker, Docker Compose, Caddy |
