salman/igny8
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ad895fcb3a19573c6e16c99ef808e5b4a163ae55
igny8/docs
History
IGNY8 VPS (Salman) 6e2101d019 feat: add Usage Limits Panel component with usage tracking and visual indicators for limits 
style: implement custom color schemes and gradients for account section, enhancing visual hierarchy
2025-12-12 13:15:15 +00:00
..
00-SYSTEM
docs re-org
2025-12-09 13:26:35 +00:00
10-BACKEND
docs re-org
2025-12-09 13:26:35 +00:00
20-API
docs re-org
2025-12-09 13:26:35 +00:00
30-FRONTEND
docs re-org
2025-12-09 13:26:35 +00:00
40-WORKFLOWS
docs re-org
2025-12-09 13:26:35 +00:00
50-DEPLOYMENT
docs re-org
2025-12-09 13:26:35 +00:00
90-ARCHIVED
docs re-org
2025-12-09 13:26:35 +00:00
multi-tenancy
asda
2025-12-09 13:27:29 +00:00
package-backup
docs-reorg
2025-12-11 01:23:17 +05:00
PRE-LAUNCH
pre-launch-final mods-docs
2025-12-11 07:20:21 +00:00
.structure-plan.txt
docs re-org
2025-12-09 13:26:35 +00:00
PLAN-LIMITS.md
feat: add Usage Limits Panel component with usage tracking and visual indicators for limits
2025-12-12 13:15:15 +00:00
README.md
docs re-org
2025-12-09 13:26:35 +00:00

README.md

IGNY8 Documentation - Master Index

Last Updated: December 9, 2024
Purpose: Single source of truth - Find any file, function, or feature in 1-2 steps

🎯 Quick Find - Start Here

I want to...

Task Go To File Location Reference
Add a new feature Find module below → Open reference doc See "Code Locations" in each doc
Fix a bug Find workflow → See exact function Function names listed (no code)
Understand data flow 40-WORKFLOWS/ Visual diagrams included
Find an API endpoint 20-API/ Endpoint + handler location
Modify UI component 30-FRONTEND/ Component path + props
Change database model 10-BACKEND/MODELS.md Model + fields + file path
Deploy or configure 50-DEPLOYMENT/ Environment setup

📚 Documentation Structure

00-SYSTEM - System Architecture

Purpose: High-level design, tech stack, core concepts

File What's Inside When to Read
ARCHITECTURE-OVERVIEW.md System design, microservices, architecture patterns Understanding overall system
TECH-STACK.md All technologies: Django, React, PostgreSQL, Redis, Celery Technology decisions
MULTITENANCY.md Account isolation, tenant context, middleware Multi-tenant features
AUTHENTICATION.md JWT tokens, sessions, permissions, roles Auth/authz changes
DATA-FLOWS.md Cross-system workflows with diagrams Understanding flows

10-BACKEND - Backend Services & Models

Purpose: All backend code locations, models, services, business logic

Core Backend Files

File What's Inside When to Read
OVERVIEW.md Backend architecture, module structure Understanding backend organization
MODELS.md All database models with fields (no code) Database schema reference
SERVICES.md Business logic services and their purposes Service layer understanding

Module-Specific References

Module File What's Inside
Accounts accounts/ACCOUNTS-REFERENCE.md User, Account, Role models + auth endpoints
📁 backend/igny8_core/auth/
Billing billing/BILLING-REFERENCE.md Plans, Subscriptions, Invoices, Payments
📁 backend/igny8_core/business/billing/
Billing billing/CREDITS-SYSTEM.md Credit allocation, deduction, transactions
📁 services/credit_service.py
Billing billing/PAYMENT-METHODS.md Payment method config, manual approvals
📁 models.py + admin.py
Planner planner/PLANNER-REFERENCE.md Keywords → Clusters → Ideas pipeline
📁 backend/igny8_core/business/planning/
Planner planner/KEYWORD-CLUSTERING.md Clustering algorithm, similarity scoring
📁 services/keyword_service.py
Planner planner/IDEA-GENERATION.md AI-powered idea generation from clusters
📁 services/idea_service.py
Writer writer/WRITER-REFERENCE.md Content, Tasks, Publishing models
📁 backend/igny8_core/business/content/
Writer writer/CONTENT-GENERATION.md AI content creation flow, prompts
📁 services/content_generation_service.py
Writer writer/IMAGES-SYSTEM.md Image generation, storage, management
📁 services/image_service.py
Writer writer/PUBLISHING.md Review workflow, status transitions
📁 views.py + serializers.py
Automation automation/AUTOMATION-REFERENCE.md Full automation pipeline overview
📁 backend/igny8_core/business/automation/
Automation automation/PIPELINE-STAGES.md Stage-by-stage breakdown with functions
📁 services/automation_service.py
Automation automation/SCHEDULER.md Celery tasks, scheduling, background jobs
📁 tasks.py
Integrations integrations/WORDPRESS-INTEGRATION.md WordPress sync, publishing, webhooks
📁 backend/igny8_core/business/integration/
Integrations integrations/AI-SERVICES.md OpenAI, Anthropic API integration
📁 backend/igny8_core/ai/
Integrations integrations/IMAGE-GENERATION.md DALL-E, Stability AI integration
📁 services/image_generation.py
Sites sites/SITES-REFERENCE.md Site, Sector, Industry models
📁 backend/igny8_core/auth/models.py

20-API - REST API Endpoints

Purpose: All API endpoints with request/response formats and handler locations

File What's Inside When to Read
API-REFERENCE.md Complete endpoint list with methods API overview
AUTHENTICATION-ENDPOINTS.md Login, register, tokens, refresh
📁 auth/views.py + auth/urls.py		 Auth API changes
PLANNER-ENDPOINTS.md Keywords, clusters, ideas CRUD
📁 modules/planner/views.py		 Planner API
WRITER-ENDPOINTS.md Content, tasks, images CRUD
📁 modules/writer/views.py		 Writer API
AUTOMATION-ENDPOINTS.md Start/stop automation, status
📁 modules/automation/views.py		 Automation API
BILLING-ENDPOINTS.md Invoices, payments, credits
📁 business/billing/views.py		 Billing API
INTEGRATION-ENDPOINTS.md WordPress, external services
📁 modules/integration/views.py		 Integration API

30-FRONTEND - React UI Components & State

Purpose: Frontend architecture, components, state management, pages

File What's Inside When to Read
FRONTEND-ARCHITECTURE.md React structure, routing, file organization Frontend overview
STATE-MANAGEMENT.md Zustand stores, state flow
📁 frontend/src/store/		 State changes
COMPONENTS.md Reusable UI components library
📁 frontend/src/components/		 Component usage

Module UI References

Module File What's Inside
Planner planner/PLANNER-UI.md Keywords, clusters, ideas pages
📁 frontend/src/pages/planner/
Writer writer/WRITER-UI.md Content, tasks, publishing UI
📁 frontend/src/pages/writer/
Automation automation/AUTOMATION-UI.md Automation dashboard, controls
📁 frontend/src/pages/automation/
Billing billing/BILLING-UI.md Plans, payments, invoices UI
📁 frontend/src/pages/billing/

40-WORKFLOWS - Complete User Journeys

Purpose: End-to-end workflows with visual diagrams (no code)

File What's Inside When to Read
SIGNUP-TO-ACTIVE.md User signup → Payment → Account activation Onboarding flow
CONTENT-LIFECYCLE.md Keyword → Cluster → Idea → Task → Content → Published Content creation
PAYMENT-WORKFLOW.md User payment → Admin approval → Credit allocation Payment processing
AUTOMATION-WORKFLOW.md Full automation run with all stages Automation understanding
WORDPRESS-SYNC.md Bidirectional sync between IGNY8 ↔ WordPress WP integration

50-DEPLOYMENT - Environment & Deployment

Purpose: Setup, deployment, configuration guides

File What's Inside When to Read
ENVIRONMENT-SETUP.md Local, staging, production setup Environment config
DOCKER-DEPLOYMENT.md Container setup, docker-compose Container deployment
DATABASE-MIGRATIONS.md Migration strategy, commands Schema changes

90-ARCHIVED - Historical Reference

Purpose: Old documentation kept for reference (deprecated)

Archived files from previous documentation iterations.

🔍 Search Strategies

By Feature

Feature Start Here Then Read
User Signup 40-WORKFLOWS/SIGNUP-TO-ACTIVE.md 10-BACKEND/accounts/
Content Generation 40-WORKFLOWS/CONTENT-LIFECYCLE.md 10-BACKEND/writer/CONTENT-GENERATION.md
Payment Processing 40-WORKFLOWS/PAYMENT-WORKFLOW.md 10-BACKEND/billing/
WordPress Publishing 40-WORKFLOWS/WORDPRESS-SYNC.md 10-BACKEND/integrations/WORDPRESS-INTEGRATION.md
Automation Run 40-WORKFLOWS/AUTOMATION-WORKFLOW.md 10-BACKEND/automation/

By Technology

Technology Where Used Documentation
Django REST Framework Backend API 20-API/
React 19 Frontend UI 30-FRONTEND/
Zustand State Management 30-FRONTEND/STATE-MANAGEMENT.md
PostgreSQL Database 10-BACKEND/MODELS.md
Celery Background Tasks 10-BACKEND/automation/SCHEDULER.md
JWT Authentication 00-SYSTEM/AUTHENTICATION.md
OpenAI AI Content 10-BACKEND/integrations/AI-SERVICES.md

By Code Location

Directory Documentation
backend/igny8_core/auth/ 10-BACKEND/accounts/
backend/igny8_core/business/billing/ 10-BACKEND/billing/
backend/igny8_core/business/planning/ 10-BACKEND/planner/
backend/igny8_core/business/content/ 10-BACKEND/writer/
backend/igny8_core/business/automation/ 10-BACKEND/automation/
backend/igny8_core/business/integration/ 10-BACKEND/integrations/
frontend/src/pages/ 30-FRONTEND/
frontend/src/store/ 30-FRONTEND/STATE-MANAGEMENT.md
frontend/src/components/ 30-FRONTEND/COMPONENTS.md

📖 Documentation Standards

Every doc file includes:

  1. Purpose Statement - What this document covers
  2. File Locations - Exact paths to code files (no code shown)
  3. Function/Class Names - What to look for in files
  4. Related Docs - Cross-references to other documentation
  5. Data Flows - Visual workflows (ASCII diagrams allowed)

What's NOT in docs:

❌ Code snippets
❌ Implementation details
❌ Line-by-line walkthroughs

What IS in docs:

✅ File paths: backend/igny8_core/business/billing/services/credit_service.py
✅ Function names: CreditService.add_credits(account, amount, type, description)
✅ Model fields: account.credits, invoice.total, payment.status
✅ Endpoints: POST /v1/billing/admin/payments/confirm/
✅ Workflows: ASCII diagrams, state tables, field mappings

🎓 Example Usage

Scenario 1: "I want to add a new payment method"

  1. Start: Check Quick Find table
  2. Navigate to: 10-BACKEND/billing/PAYMENT-METHODS.md
  3. Find:
    • Model: PaymentMethodConfig
    • File: backend/igny8_core/business/billing/models.py
    • Admin: PaymentMethodConfigAdmin in admin.py
  4. Read: Field descriptions, validation rules
  5. Modify: Open exact files, add new payment method

Scenario 2: "Content generation is broken"

  1. Start: 40-WORKFLOWS/CONTENT-LIFECYCLE.md
  2. Follow: Visual flow diagram
  3. Identify: Which stage is failing
  4. Navigate to: 10-BACKEND/writer/CONTENT-GENERATION.md
  5. Find:
    • Service: ContentGenerationService
    • File: backend/igny8_core/business/content/services/content_generation_service.py
    • Function: generate_content(task_id)
  6. Debug: Open exact file, check function

Scenario 3: "How do I add a new API endpoint?"

  1. Start: 20-API/API-REFERENCE.md
  2. Find: Similar endpoint pattern
  3. Navigate to: Module-specific endpoint doc (e.g., 20-API/PLANNER-ENDPOINTS.md)
  4. Learn:
    • ViewSet location
    • Serializer pattern
    • URL routing
  5. Implement: Follow exact same structure

🔄 Keeping Docs Updated

When to update:

  • ✅ New feature added → Update relevant module doc
  • ✅ API changed → Update endpoint doc
  • ✅ Workflow modified → Update workflow doc
  • ✅ Model field added → Update MODELS.md

Update checklist:

  1. Update module reference doc (e.g., PLANNER-REFERENCE.md)
  2. Update API doc if endpoint changed
  3. Update workflow doc if flow changed
  4. Update CHANGELOG.md with change summary
  5. Do NOT add code to docs - only file paths and function names

📞 Need Help?

Finding the right doc:

  1. Feature-based: Start with 40-WORKFLOWS/
  2. Module-based: Start with 10-BACKEND/ or 30-FRONTEND/
  3. API-based: Start with 20-API/
  4. Setup-based: Start with 50-DEPLOYMENT/

Still can't find it?

Check CHANGELOG.md for recent changes that might point you to the right doc.

Last Updated: December 9, 2024
Maintained By: Development Team
Format: Markdown with no code snippets

Reference in New Issue View Git Blame Copy Permalink