igny8/docs/INDEX.md

IGNY8 Technical Documentation

Version: 1.0.5
Last Updated: December 25, 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
Work with a specific module	10-MODULES/
Find an API endpoint	20-API/ENDPOINTS.md
Understand frontend structure	30-FRONTEND/PAGES.md
Trace a workflow end-to-end	40-WORKFLOWS/
Look up model fields	90-REFERENCE/MODELS.md
Troubleshoot issues	90-REFERENCE/TROUBLESHOOTING.md

---

00-SYSTEM - Architecture & Core

Document	Purpose
ARCHITECTURE.md	Tech stack, deployment, system design
AUTH-FLOWS.md	Authentication, JWT, sessions, roles
TENANCY.md	Multi-tenant architecture, Account/Site/Sector

---

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	Credits, plans, payments	BILLING.md
Integrations	✅ Active	WordPress sync, webhooks	INTEGRATIONS.md
System	✅ Active	Settings, prompts, AI config	SYSTEM-SETTINGS.md
Publisher	✅ Active	Content publishing pipeline	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
PAGES.md	All pages and routes
STORES.md	Zustand state management
COMPONENTS.md	Key reusable components

---

40-WORKFLOWS - Cross-Module Flows

Document	Purpose
CONTENT-PIPELINE.md	Keyword → Published article flow
CREDIT-DEDUCTION.md	When and how credits are used
WORDPRESS-SYNC.md	Two-way WordPress synchronization

---

90-REFERENCE - Quick Lookup

Document	Purpose
MODELS.md	All database models and fields
AI-FUNCTIONS.md	AI engine capabilities and costs
TROUBLESHOOTING.md	Common issues and fixes

---

Root Files

File	Purpose
/CHANGELOG.md	Version history and changes
/RULES.md	Documentation maintenance rules
/IGNY8-APP.md	Executive summary (non-technical)

---

Module → File Quick Reference

Module	Backend Path	Frontend Path
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/Billing/
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
Auth	backend/igny8_core/auth/	frontend/src/pages/Auth/
AI Engine	backend/igny8_core/ai/	N/A

---

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.1, Django REST Framework, PostgreSQL
Frontend	React 18, TypeScript, Vite, Tailwind CSS
State	Zustand
Async	Celery + Redis
AI	OpenAI (GPT-4), DALL-E 3, Runware
Auth	JWT + Session
Deployment	Docker, Caddy