igny8/docs/INDEX.md

IGNY8 Technical Documentation

Version: 1.8.4
Last Updated: January 20, 2026
Purpose: Complete technical reference for the IGNY8 AI content platform

---

Quick Navigation

I want to...	Go to
Understand system architecture	00-SYSTEM/ARCHITECTURE.md
See repository structure	00-SYSTEM/REPO-STRUCTURE.md
Read executive summary	00-SYSTEM/IGNY8-APP.md
Work with a specific module	10-MODULES/
Find an API endpoint	20-API/ENDPOINTS.md
Use UI components	30-FRONTEND/COMPONENT-SYSTEM.md
Check design tokens	30-FRONTEND/DESIGN-TOKENS.md
Read design guide	30-FRONTEND/DESIGN-GUIDE.md
Understand frontend structure	30-FRONTEND/PAGES.md
Trace a workflow end-to-end	40-WORKFLOWS/
Automation & Publishing Scheduling	40-WORKFLOWS/AUTOMATION-AND-PUBLISHING-SCHEDULING.md
Manage WordPress plugin	60-PLUGINS/WORDPRESS-INTEGRATION.md
Release plugin update	60-PLUGINS/PLUGIN-UPDATE-WORKFLOW.md
Look up model fields	90-REFERENCE/MODELS.md
Billing & Credits (Complete)	10-MODULES/BILLING-PAYMENTS-COMPLETE.md
Payment gateways (Stripe/PayPal/Bank)	90-REFERENCE/PAYMENT-SYSTEM.md
See prelaunch checklist	plans/LAUNCH-VERIFICATION-CHECKLIST.md
Understand publishing flow	50-DEPLOYMENT/WORDPRESS-INTEGRATION-FLOW.md
AI model architecture (v1.4.0)	plans/4th-jan-refactor/final-model-schemas.md

---

00-SYSTEM - Architecture & Core

Document	Purpose
ARCHITECTURE.md	Tech stack, deployment, system design
REPO-STRUCTURE.md	Repository layout and directory trees
AUTH-FLOWS.md	Authentication, JWT, sessions, roles
TENANCY.md	Multi-tenant architecture, Account/Site/Sector
IGNY8-APP.md	Executive summary (non-technical)

---

10-MODULES - Feature Modules

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

---

20-API - REST API Reference

Document	Purpose
ENDPOINTS.md	Complete endpoint list with methods and handlers
SCHEMAS.md	Request/response examples

---

30-FRONTEND - React Application

Document	Purpose
COMPONENT-SYSTEM.md	UI components reference (Button, InputField, etc.)
DESIGN-GUIDE.md	Design system guide (colors, rules)
DESIGN-TOKENS.md	Design tokens (CSS variables, color scales)
PAGE-AUDIT.md	Page-by-page function audit (in progress)
PAGES.md	All pages and routes
PAGE-REQUIREMENTS.md	Site/sector selector requirements
STORES.md	Zustand state management

Current Page Structure (v1.8.3)

/                           → Dashboard (Home.tsx)
├── AUTH
│   /signin                 → Sign In (SignIn.tsx)
│   /signup                 → Sign Up (SignUp.tsx)
│   /signup/pk              → Legacy redirect to Sign Up
│   /forgot-password        → Forgot Password (ForgotPassword.tsx)
│   /reset-password         → Reset Password (ResetPassword.tsx)
│   /verify-email           → Verify Email (VerifyEmail.tsx)
│   /unsubscribe            → Unsubscribe (Unsubscribe.tsx)
│   /payment                → Payment (Payment.tsx)
├── LEGAL
│   /terms                  → Terms (Terms.tsx)
│   /privacy                → Privacy (Privacy.tsx)
├── SETUP
│   /setup/wizard           → Onboarding Wizard (SetupWizard.tsx)
│   /keywords-library       → Keywords Library (IndustriesSectorsKeywords.tsx)
├── SITES
│   /sites                  → Sites List (List.tsx)
│   /sites/:id              → Site Dashboard (Dashboard.tsx)
│   /sites/:id/pages        → Page Manager (PageManager.tsx)
│   /sites/:id/content      → Site Content (Content.tsx)
│   /sites/:id/content/structure → Content Structure (ContentStructure.tsx)
│   /sites/:id/settings     → Site Settings (Settings.tsx)
│   /sites/:id/sync         → Sync Dashboard (SyncDashboard.tsx)
│   /sites/:id/deploy       → Deployment Panel (DeploymentPanel.tsx)
│   /sites/:id/posts/:postId → Post Editor (PostEditor.tsx)
├── WORKFLOW
│   /planner/keywords       → Planner Keywords (Keywords.tsx)
│   /planner/clusters       → Planner Clusters (Clusters.tsx)
│   /planner/clusters/:id   → Cluster Detail (ClusterDetail.tsx)
│   /planner/ideas          → Planner Ideas (Ideas.tsx)
│   /writer/tasks           → Writer Tasks (Tasks.tsx)
│   /writer/content         → Writer Content (Content.tsx)
│   /writer/content/:id     → Content View (ContentView.tsx)
│   /writer/images          → Writer Images (Images.tsx)
│   /writer/review          → Review Queue (Review.tsx)
│   /writer/approved        → Approved (Approved.tsx)
│   /automation/overview    → Automation Runs (AutomationOverview.tsx)
│   /automation/runs/:runId → Run Detail (AutomationRunDetail.tsx)
│   /automation/run         → Automation Run (AutomationPage.tsx)
├── PUBLISHER
│   /publisher/content-calendar → Content Calendar (ContentCalendar.tsx)
├── OPTIONAL MODULES
│   /linker/content         → Linker Content (ContentList.tsx)
│   /optimizer/content      → Optimizer Content (ContentSelector.tsx)
│   /optimizer/analyze/:id  → Optimization Preview (AnalysisPreview.tsx)
├── THINKER (ADMIN)
│   /thinker/prompts        → Prompts (Prompts.tsx)
│   /thinker/author-profiles → Author Profiles (AuthorProfiles.tsx)
│   /thinker/profile        → Thinker Profile (Profile.tsx)
│   /thinker/strategies     → Strategies (Strategies.tsx)
│   /thinker/image-testing  → Image Testing (ImageTesting.tsx)
├── ACCOUNT
│   /account/notifications  → Notifications (NotificationsPage.tsx)
│   /account/settings       → Account Settings (AccountSettingsPage.tsx)
│   /account/settings/profile → Profile Tab
│   /account/settings/team  → Team Tab
│   /account/plans          → Plans & Billing (PlansAndBillingPage.tsx)
│   /account/plans/upgrade  → Upgrade Tab
│   /account/plans/history  → History Tab
│   /account/usage          → Usage Dashboard (UsageDashboardPage.tsx)
│   /account/content-settings → Content Settings (ContentSettingsPage.tsx)
├── SETTINGS
│   /settings               → General Settings (General.tsx)
│   /settings/users         → Users (Users.tsx)
│   /settings/subscriptions → Subscriptions (Subscriptions.tsx)
│   /settings/system        → System Settings (System.tsx)
│   /settings/account       → Account Settings (Account.tsx)
│   /settings/plans         → Plans (Plans.tsx)
│   /settings/industries    → Industries (Industries.tsx)
│   /settings/integration   → Integration (Integration.tsx) [Admin]
│   /settings/publishing    → Publishing (Publishing.tsx)
│   /settings/sites         → Sites Settings (Sites.tsx)
├── REFERENCE
│   /reference/seed-keywords → Seed Keywords (SeedKeywords.tsx)
│   /reference/industries   → Industries (Industries.tsx)
├── HELP
│   /help                   → Help Center (Help.tsx)
└── INTERNAL
    /ui-elements            → UI Elements (UIElements.tsx)
    /components             → Components (Components.tsx)

Removed in v1.8.0:

• /automation/settings - Merged into Site Settings → Automation tab
• /publisher/settings - Merged into Site Settings → Automation tab
• /sites/:id/settings AI Settings tab - Merged into Automation tab

Removed in v1.4.0:

• /settings/ai - AI Settings page merged into Site Settings AI tab

---

40-WORKFLOWS - Cross-Module Flows

Document	Purpose
CONTENT-PIPELINE.md	Keyword → Published article flow
CREDIT-SYSTEM.md	When and how credits are used

---

60-PLUGINS - Plugin Distribution & Management

Document	Purpose
INDEX.md	Plugin management overview
WORDPRESS-INTEGRATION.md	Complete WordPress integration guide (app-side)
PLUGIN-UPDATE-WORKFLOW.md	How to release updates, verification checklist

Key Points:

• Plugin source: /plugins/wordpress/source/igny8-wp-bridge/
• Distribution: /plugins/wordpress/dist/
• Django app: /backend/igny8_core/plugins/
• API domain: api.igny8.com (not app.igny8.com)

---

90-REFERENCE - Quick Lookup

Document	Purpose
MODELS.md	All database models and fields
AI-FUNCTIONS.md	AI engine capabilities and costs
PAYMENT-SYSTEM.md	Payment gateways (Stripe, PayPal, Bank Transfer)
TROUBLESHOOTING.md	Common issues and fixes

---

Root Files

File	Purpose
/CHANGELOG.md	Version history and changes
/IGNY8-APP.md	Platform overview (non-technical)
/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