igny8/docs/README.md

IGNY8 Documentation

Last Updated: 2025-01-XX
Purpose: Complete documentation index for the IGNY8 platform.

---

📚 Documentation Structure

All documentation is organized in this single folder with the following structure:

Core Documentation

1. 01-ARCHITECTURE-TECH-STACK.md

   • Technology stack overview
   • System architecture principles
   • Infrastructure components
   • External service integrations

2. 02-APP-ARCHITECTURE.md

   • IGNY8 application architecture
   • System hierarchy and relationships
   • Module organization
   • Complete workflows
   • Data flow and processing
   • Multi-tenancy architecture
   • Security architecture

3. 03-FRONTEND.md

   • Frontend architecture
   • Project structure
   • Routing system
   • Template system
   • Component library
   • State management
   • API integration
   • Configuration system
   • All pages and features

4. 04-BACKEND.md

   • Backend architecture
   • Project structure
   • Models and relationships
   • ViewSets and API endpoints
   • Serializers
   • Celery tasks
   • Middleware
   • All modules (Planner, Writer, System, Billing, Auth)

5. 05-AI-FUNCTIONS.md

   • AI framework architecture
   • All 5 AI functions (complete details)
   • AI function execution flow
   • Prompt management
   • Model configuration
   • Progress tracking
   • Cost tracking

6. 06-CHANGELOG.md

   • System changelog
   • Feature additions
   • Updates and improvements
   • Version history

---

🚀 Quick Start

1. New to IGNY8? Start with 01-ARCHITECTURE-TECH-STACK.md for technology overview
2. Understanding the System? Read 02-APP-ARCHITECTURE.md for complete architecture
3. Frontend Development? See 03-FRONTEND.md for all frontend details
4. Backend Development? See 04-BACKEND.md for all backend details
5. Working with AI? See 05-AI-FUNCTIONS.md for AI functions
6. What's New? Check 06-CHANGELOG.md for recent changes

---

📋 Documentation Overview

System Capabilities

• Multi-Tenancy: Complete account isolation with automatic filtering
• Planner Module: Keywords, Clusters, Content Ideas management
• Writer Module: Tasks, Content, Images generation and management
• Thinker Module: Prompts, Author Profiles, Strategies, Image Testing
• System Module: Settings, Integrations, AI Prompts
• Billing Module: Credits, Transactions, Usage Logs
• AI Functions: 5 AI operations (Auto Cluster, Generate Ideas, Generate Content, Generate Image Prompts, Generate Images)

Technology Stack

• Backend: Django 5.2+ with Django REST Framework
• Frontend: React 19 with TypeScript and Vite
• Database: PostgreSQL 15
• Task Queue: Celery with Redis
• Deployment: Docker-based containerization
• Reverse Proxy: Caddy (HTTPS)

---

🔍 Finding Information

By Topic

• Architecture & Design: 01-ARCHITECTURE-TECH-STACK.md, 02-APP-ARCHITECTURE.md
• Frontend Development: 03-FRONTEND.md
• Backend Development: 04-BACKEND.md
• AI Functions: 05-AI-FUNCTIONS.md
• Changes & Updates: 06-CHANGELOG.md

By Module

• Planner: See 02-APP-ARCHITECTURE.md (Module Organization) and 04-BACKEND.md (Planner Module)
• Writer: See 02-APP-ARCHITECTURE.md (Module Organization) and 04-BACKEND.md (Writer Module)
• Thinker: See 03-FRONTEND.md (Thinker Pages) and 04-BACKEND.md (System Module)
• System: See 04-BACKEND.md (System Module)
• Billing: See 04-BACKEND.md (Billing Module)

---

📝 Documentation Standards

• No Code: Documentation focuses on workflows, features, and architecture (no code snippets)
• Complete: All workflows and features are documented
• Accurate: Documentation reflects current system state
• Detailed: Comprehensive coverage of all aspects

---

🔄 Keeping Documentation Updated

Documentation is updated when:

• New features are added
• Workflows change
• Architecture evolves
• Modules are modified

Last Review: 2025-01-XX
Next Review: As system evolves

---

📞 Support

For questions or clarifications about the documentation, refer to the specific document or contact the development team.