salman/igny8
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs update

Browse Source
This commit is contained in:
IGNY8 VPS (Salman)
2025-12-25 23:18:35 +00:00
parent 91525b8999
commit 444d53dc7b
4 changed files with 646 additions and 318 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
docs/INDEX.md
View File

@@ -1,6 +1,6 @@
# IGNY8 Technical Documentation
**Version:** 1.0.5
**Version:** 1.1.0
**Last Updated:** December 25, 2025
**Purpose:** Complete technical reference for the IGNY8 AI content platform
@@ -17,6 +17,7 @@
| Trace a workflow end-to-end | [40-WORKFLOWS/](#workflows) |
| Look up model fields | [90-REFERENCE/MODELS.md](90-REFERENCE/MODELS.md) |
| Troubleshoot issues | [90-REFERENCE/TROUBLESHOOTING.md](90-REFERENCE/TROUBLESHOOTING.md) |
| See known issues | [/PRE-LAUNCH-AUDIT.md](/PRE-LAUNCH-AUDIT.md) |
---
@@ -63,6 +64,41 @@
| [STORES.md](30-FRONTEND/STORES.md) | Zustand state management |
| [COMPONENTS.md](30-FRONTEND/COMPONENTS.md) | Key reusable components |
### Current Page Structure (v1.1.0)
```
/ → Dashboard (Home.tsx)
├── SETUP
│ /setup/add-keywords → Add Keywords (AddKeywords.tsx)
│ /account/content-settings → Content Settings (ContentSettingsPage.tsx)
│ /sites → Sites List (List.tsx)
│ /sites/:id/settings → Site Settings (SiteSettings.tsx)
│ /thinker/prompts → Thinker Prompts (Prompts.tsx) [Admin]
│ /thinker/author-profiles → Author Profiles (AuthorProfiles.tsx) [Admin]
├── WORKFLOW
│ /planner/keywords → Planner Keywords (Keywords.tsx)
│ /planner/clusters → Clusters (Clusters.tsx)
│ /planner/ideas → Ideas (Ideas.tsx)
│ /writer/tasks → Writer Queue (Tasks.tsx)
│ /writer/drafts → Drafts (Drafts.tsx)
│ /writer/images → Images (Images.tsx)
│ /writer/review → Review (Review.tsx)
│ /writer/published → Published (Published.tsx)
│ /automation → Automation Dashboard (Dashboard.tsx)
│ /linker/content → Linker [if enabled]
│ /optimizer/content → Optimizer [if enabled]
├── ACCOUNT
│ /account/settings → Account Settings (AccountSettingsPage.tsx)
│ - Tabs: Account, Profile, Team
│ /account/plans → Plans & Billing (PlansAndBillingPage.tsx)
│ - Tabs: Plan, Upgrade, History
│ /account/usage → Usage Analytics (UsageAnalyticsPage.tsx)
│ - Tabs: Limits, Credit History, API Activity
│ /settings/integration → AI Models (IntegrationPage.tsx) [Admin]
└── HELP
/help → Help Center (HelpCenter.tsx)
```
---
## 40-WORKFLOWS - Cross-Module Flows {#workflows}
@@ -90,8 +126,8 @@
| File | Purpose |
|------|---------|
| [/CHANGELOG.md](/CHANGELOG.md) | Version history and changes |
| [/RULES.md](/RULES.md) | Documentation maintenance rules |
| [/IGNY8-APP.md](/IGNY8-APP.md) | Executive summary (non-technical) |
| [/IGNY8-APP.md](/IGNY8-APP.md) | Platform overview (non-technical) |
| [/PRE-LAUNCH-AUDIT.md](/PRE-LAUNCH-AUDIT.md) | Known issues and improvement roadmap |
---
@@ -99,17 +135,23 @@
| 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/Billing/` |
| 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 |
| Auth | `backend/igny8_core/auth/` | `frontend/src/pages/Auth/` |
| 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/` |
---
@@ -133,10 +175,10 @@
| Layer | Technology |
|-------|------------|
| Backend | Django 5.1, Django REST Framework, PostgreSQL |
| Frontend | React 18, TypeScript, Vite, Tailwind CSS |
| Backend | Django 5.x, Django REST Framework, PostgreSQL 15+ |
| Frontend | React 19, TypeScript, Vite, TailwindCSS |
| State | Zustand |
| Async | Celery + Redis |
| AI | OpenAI (GPT-4), DALL-E 3, Runware |
| Auth | JWT + Session |
| Deployment | Docker, Caddy |
| AI | OpenAI (GPT-4, GPT-4 Turbo), DALL-E 3, Runware |
| Auth | JWT + Redis Sessions |
| Deployment | Docker, Docker Compose, Caddy |