IGNY8 Documentation Index (Dec 2025)
Purpose: single entry point for all project docs with live links to the current sources. This index reflects the codebase as implemented, not legacy placeholders.
Codebase Snapshot
- Backend (Django/DRF): Multi-tenant models inherit
AccountBaseModel/SiteSectorBaseModelfor automatic tenant scoping (backend/igny8_core/auth/models.py). API namespaces are wired inbackend/igny8_core/urls.py:/api/v1/auth/,/api/v1/account/,/api/v1/planner/,/api/v1/writer/,/api/v1/system/,/api/v1/billing/(tenant billing/invoices/credits),/api/v1/admin/(billing admin + credit costs/stats),/api/v1/automation/,/api/v1/linker/,/api/v1/optimizer/,/api/v1/publisher/,/api/v1/integration/. - Frontend (React/Vite): Routing lives in
frontend/src/App.tsxwith lazy-loaded pages; account/billing pages at/account/plans,/account/billing,/account/purchase-credits,/account/settings,/account/team,/account/usage, plus tenant billing module routes under/billing/*and admin billing under/admin/*. Sidebar labels/paths are defined infrontend/src/layout/AppSidebar.tsx.
Document Map
- App Architecture (code-sourced):
docs/igny8-app/IGNY8-APP-ARCHITECTURE.md - Backend Architecture (code-sourced):
docs/backend/IGNY8-BACKEND-ARCHITECTURE.md - Planner Backend Detail:
docs/backend/IGNY8-PLANNER-BACKEND.md - Writer Backend Detail:
docs/backend/IGNY8-WRITER-BACKEND.md - Platform / Tech Stack:
docs/tech-stack/00-SYSTEM-ARCHITECTURE-MASTER-REFERENCE.md - API:
docs/API/01-IGNY8-REST-API-COMPLETE-REFERENCE.md,docs/API/API-COMPLETE-REFERENCE-LATEST.md - Billing & Credits (canonical):
docs/billing/billing-account-final-plan-2025-12-05.md,docs/billing/credits-system-audit-and-improvement-plan.md - App Feature Guides:
docs/igny8-app/02-PLANNER-WRITER-WORKFLOW-TECHNICAL-GUIDE.md,docs/igny8-app/05-WRITER-IMAGES-PAGE-SYSTEM-DESIGN.md,docs/igny8-app/06-FEATURE-MODIFICATION-DEVELOPER-GUIDE.md,docs/igny8-app/KEYWORDS-CLUSTERS-IDEAS-COMPLETE-MAPPING.md,docs/igny8-app/app-packaging-backaup-plan.md,docs/igny8-app/TAXONOMY/*,docs/igny8-app/status-related-temporary/* - Automation:
docs/automation/(automation-plan, implementation analysis, UX improvements, stage-6 image generation fix, cluster validation fix plan) - AI Functions:
docs/ai/AI-FUNCTIONS-COMPLETE-REFERENCE.md - Automation:
docs/automation/AUTOMATION-REFERENCE.md - WordPress Integration:
docs/wp/(API integration guide, bidirectional sync reference, publishing field mapping, refactor/implementation summaries, deployment fixes) - User Flow Drafts: root-level
user-flow-plan*.md(in-progress drafts);docs/user-flow/is currently empty and needs coverage. - Docs Changelog:
docs/CHANGELOG.md
Known Documentation Gaps to Close
- App-level architecture summary sourced from code (backend modules and frontend routes), including tenant scoping rules.
- Billing/account accuracy pass: align docs to current endpoints in
igny8_core/urls.pyand admin aliases inmodules/billing/admin_urls.py, plus the active frontend routes inApp.tsx. - Frontend route/UX map for account/billing/admin sections tied to sidebar paths.
- Multi-tenancy guardrails doc (account/site/sector isolation, role expectations) based on
auth/models.py.