docs 1
This commit is contained in:
24
README.md
24
README.md
@@ -25,13 +25,13 @@ IGNY8 is a full-stack SaaS platform that combines AI-powered content generation
|
||||
|
||||
## Repository Structure
|
||||
|
||||
This monorepo contains two main applications:
|
||||
This monorepo contains two main applications and documentation:
|
||||
|
||||
```
|
||||
igny8/
|
||||
├── backend/ # Django REST API + Celery
|
||||
├── frontend/ # React + Vite SPA
|
||||
├── master-docs/ # Architecture documentation
|
||||
├── docs/ # Documentation index and topic folders
|
||||
└── docker-compose.app.yml # Docker deployment config
|
||||
```
|
||||
|
||||
@@ -210,14 +210,20 @@ The WordPress bridge plugin (`igny8-wp-integration`) creates a bidirectional con
|
||||
|
||||
## Documentation
|
||||
|
||||
Comprehensive documentation is available in the `master-docs/` directory:
|
||||
Start here: [docs/README.md](./docs/README.md) (index of all topics).
|
||||
|
||||
- **[MASTER_REFERENCE.md](./MASTER_REFERENCE.md)** - Complete system architecture and navigation
|
||||
- **[API-COMPLETE-REFERENCE.md](./master-docs/API-COMPLETE-REFERENCE.md)** - Full API documentation
|
||||
- **[02-APPLICATION-ARCHITECTURE.md](./master-docs/02-APPLICATION-ARCHITECTURE.md)** - System design
|
||||
- **[04-BACKEND-IMPLEMENTATION.md](./master-docs/04-BACKEND-IMPLEMENTATION.md)** - Backend details
|
||||
- **[03-FRONTEND-ARCHITECTURE.md](./master-docs/03-FRONTEND-ARCHITECTURE.md)** - Frontend details
|
||||
- **[WORDPRESS-PLUGIN-INTEGRATION.md](./master-docs/WORDPRESS-PLUGIN-INTEGRATION.md)** - Plugin integration guide
|
||||
Common entry points:
|
||||
- App architecture: `docs/igny8-app/IGNY8-APP-ARCHITECTURE.md`
|
||||
- Backend architecture: `docs/backend/IGNY8-BACKEND-ARCHITECTURE.md`
|
||||
- Planner backend detail: `docs/backend/IGNY8-PLANNER-BACKEND.md`
|
||||
- Writer backend detail: `docs/backend/IGNY8-WRITER-BACKEND.md`
|
||||
- Automation: `docs/automation/AUTOMATION-REFERENCE.md`
|
||||
- Tech stack: `docs/tech-stack/00-SYSTEM-ARCHITECTURE-MASTER-REFERENCE.md`
|
||||
- API: `docs/API/API-COMPLETE-REFERENCE-LATEST.md`
|
||||
- Billing & Credits: `docs/billing/billing-account-final-plan-2025-12-05.md`
|
||||
- App guides: `docs/igny8-app/` (planner/writer workflows, taxonomy, feature modification)
|
||||
- WordPress: `docs/wp/` (plugin integration and sync)
|
||||
- Docs changelog: `docs/CHANGELOG.md`
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user