igny8/INDEX.md

IGNY8 Documentation Index

Version: 1.8.3
Last Updated: January 20, 2026
Codebase Health: ✅ Stable

---

Quick Start

I want to...	Document
Understand the system	docs/00-SYSTEM/ARCHITECTURE.md
Follow design standards	DESIGN-GUIDE.md
Find API endpoints	docs/20-API/ENDPOINTS.md
See frontend routes	docs/30-FRONTEND/PAGES.md
Use UI components	docs/30-FRONTEND/COMPONENT-SYSTEM.md
Check changelog	CHANGELOG.md

---

System Overview

┌─────────────────────────────────────────────────────────────┐
│                         IGNY8 App                           │
├─────────────────────────────────────────────────────────────┤
│  Frontend (React 19)  │  Backend (Django 5.1)  │  WordPress │
│  - TypeScript         │  - DRF REST API        │  - Plugin  │
│  - Vite               │  - Celery Workers      │            │
│  - Tailwind CSS       │  - PostgreSQL 16       │            │
│  - Zustand            │  - Redis 7             │            │
└─────────────────────────────────────────────────────────────┘

---

Documentation Structure

/
├── INDEX.md                    ← You are here
├── DESIGN-GUIDE.md             ← UI/UX standards (MUST FOLLOW)
├── CHANGELOG.md                ← Version history
├── README.md                   ← Project overview
│
├── docs/
│   ├── 00-SYSTEM/              ← Architecture, auth, tenancy
│   │   ├── ARCHITECTURE.md
│   │   ├── AUTH-FLOWS.md
│   │   └── TENANCY.md
│   │
│   ├── 10-MODULES/             ← Feature module docs
│   │   ├── PLANNER.md
│   │   ├── WRITER.md
│   │   ├── AUTOMATION.md
│   │   ├── BILLING-PAYMENTS-COMPLETE.md
│   │   └── ...
│   │
│   ├── 20-API/                 ← API reference
│   │   └── ENDPOINTS.md
│   │
│   ├── 30-FRONTEND/            ← Frontend docs
│   │   ├── PAGES.md            ← Routes & pages
│   │   ├── COMPONENT-SYSTEM.md ← UI components
│   │   ├── STORES.md           ← Zustand state
│   │   └── DESIGN-TOKENS.md    ← CSS variables
│   │
│   ├── 40-WORKFLOWS/           ← Business workflows
│   │   └── CONTENT-PIPELINE.md
│   │
│   ├── 50-DEPLOYMENT/          ← Deploy & ops
│   │   └── DOCKER-DEPLOYMENT.md
│   │
│   ├── 60-PLUGINS/             ← WordPress plugin
│   │   └── WORDPRESS-INTEGRATION.md
│   │
│   └── 90-REFERENCE/           ← Reference docs
│       ├── MODELS.md
│       └── AI-FUNCTIONS.md
│
├── backend/                    ← Django backend
├── frontend/                   ← React frontend
└── plugins/                    ← WordPress plugin

---

Key Metrics (Auto-Generated)

Metric	Count	Source
Frontend Routes	100	App.tsx
Backend Models	52	models.py files
Zustand Stores	11	frontend/src/store/
Celery Tasks	25	@shared_task decorators
API Endpoints	150+	Django URL patterns

---

Module Status

Module	Status	Description
Planner	✅ Active	Keywords → Clusters → Ideas
Writer	✅ Active	Tasks → Content → Images
Automation	✅ Active	7-stage automated pipeline
Publisher	✅ Active	Content calendar & scheduling
Billing	✅ Active	Credits, plans, payments
Thinker	✅ Active	AI prompts & profiles (Admin)
Linker	⏸️ Phase 2	Internal linking (disabled)
Optimizer	⏸️ Phase 2	Content optimization (disabled)

---

Development Rules

⚠️ Before Any Code Change

1. Read DESIGN-GUIDE.md for UI standards
2. Check existing components before creating new ones
3. Follow project structure and naming conventions

⚠️ After Any Code Change

1. Update relevant documentation in /docs/
2. Add entry to CHANGELOG.md
3. Run ./scripts/verify-docs.sh to check accuracy

---

API Documentation

• Swagger UI: https://api.igny8.com/api/docs/
• ReDoc: https://api.igny8.com/api/redoc/
• OpenAPI Schema: https://api.igny8.com/api/schema/

---

Contact & Support

Resource	Link
GitHub	Internal repository
Production	https://app.igny8.com
API	https://api.igny8.com