mirror of
https://github.com/taylanbakircioglu/flowfish.git
synced 2026-09-16 15:45:14 +00:00
taylanbakircioglu
d7ca50b387
Multi-cluster dependency mapping, real-time network monitoring, impact analysis, and CI/CD integration capabilities. Made-with: Cursor
90 lines
3.8 KiB
Markdown
90 lines
3.8 KiB
Markdown
# 🐟 Flowfish Documentation
|
|
|
|
This directory contains all project documentation organized by category.
|
|
|
|
## 📁 Directory Structure
|
|
|
|
### `/architecture/` - Architecture & Design Documents
|
|
Technical architecture, system design, and integration details.
|
|
|
|
#### 🎯 Start Here (Architecture Overview)
|
|
- **[ARCHITECTURE_QUICK_REF.md](architecture/ARCHITECTURE_QUICK_REF.md)** - One-page architecture diagram & port reference
|
|
- **[ARCHITECTURE_SIMPLE.md](architecture/ARCHITECTURE_SIMPLE.md)** - Simple data flow diagram with service summary
|
|
- **[ARCHITECTURE_DETAILED.md](architecture/ARCHITECTURE_DETAILED.md)** - Complete layered architecture with sequences
|
|
|
|
#### Detailed Documentation
|
|
- **[MICROSERVICES_ARCHITECTURE.md](architecture/MICROSERVICES_ARCHITECTURE.md)** - Microservices architecture overview
|
|
- **[ENTERPRISE_MULTI_CLUSTER.md](architecture/ENTERPRISE_MULTI_CLUSTER.md)** - Multi-cluster enterprise architecture
|
|
- **[RABBITMQ_INTEGRATION.md](architecture/RABBITMQ_INTEGRATION.md)** - RabbitMQ message queue integration
|
|
- **[INSPECTOR_GADGET_EVENTS.md](architecture/INSPECTOR_GADGET_EVENTS.md)** - Inspektor Gadget event types
|
|
- **[HYBRID_STORAGE_ARCHITECTURE.md](architecture/HYBRID_STORAGE_ARCHITECTURE.md)** - Storage strategy (ClickHouse + Neo4j)
|
|
- **[MICROSERVICES_NAMES.md](architecture/MICROSERVICES_NAMES.md)** - Service naming conventions
|
|
- **[change-detection-worker.md](change-detection-worker.md)** - Change Detection Worker (scalable microservice)
|
|
|
|
### `/sprints/` - Sprint Plans & Roadmaps
|
|
Sprint planning, task breakdown, and development roadmaps.
|
|
|
|
- Sprint plans coming soon...
|
|
|
|
### `/analysis/` - Analysis & Status Reports
|
|
Project status, integration reports, and analysis documents.
|
|
|
|
- **[INTEGRATION_STATUS.md](analysis/INTEGRATION_STATUS.md)** - Current integration status
|
|
- **[MODERNIZATION_SUMMARY.md](analysis/MODERNIZATION_SUMMARY.md)** - UI/UX modernization summary
|
|
|
|
### `/guides/` - User & Developer Guides
|
|
How-to guides, tutorials, and best practices.
|
|
|
|
- Guides coming soon...
|
|
|
|
### Root Level Documents
|
|
Core project documentation that lives in the repository root:
|
|
|
|
- **[01-executive-summary.md](01-executive-summary.md)** - Project overview and goals
|
|
- **[02-feature-list.md](02-feature-list.md)** - Detailed feature list by phase
|
|
- **[03-architecture.md](03-architecture.md)** - High-level architecture
|
|
- **[04-technology-stack.md](04-technology-stack.md)** - Technology choices and rationale
|
|
- **[05-scalability.md](05-scalability.md)** - Scalability approach
|
|
- **[06-security.md](06-security.md)** - Security design
|
|
- **[07-roadmap.md](07-roadmap.md)** - Project roadmap
|
|
|
|
---
|
|
|
|
## 📋 Quick Links
|
|
|
|
### For Developers
|
|
- 🎯 [Architecture Quick Reference](architecture/ARCHITECTURE_QUICK_REF.md) - Start here!
|
|
- [Simple Architecture Diagram](architecture/ARCHITECTURE_SIMPLE.md)
|
|
- [Detailed Architecture](architecture/ARCHITECTURE_DETAILED.md)
|
|
- [Microservices Architecture](architecture/MICROSERVICES_ARCHITECTURE.md)
|
|
- [Getting Started](../README.md)
|
|
- [Local Development](../deployment/kubernetes-manifests/00-local-setup.md)
|
|
|
|
### For DevOps
|
|
- [Kubernetes Deployment](../deployment/kubernetes-manifests/00-README.md)
|
|
- [Multi-Cluster Setup](architecture/ENTERPRISE_MULTI_CLUSTER.md)
|
|
- [RabbitMQ Integration](architecture/RABBITMQ_INTEGRATION.md)
|
|
|
|
### For Project Managers
|
|
- [Executive Summary](01-executive-summary.md)
|
|
- [Feature List](02-feature-list.md)
|
|
- [Roadmap](07-roadmap.md)
|
|
- [Sprint Status](sprints/SPRINT_5-6_CURRENT_STATUS.md)
|
|
|
|
---
|
|
|
|
## 🔄 Document Status
|
|
|
|
| Category | Status | Last Updated |
|
|
|----------|--------|--------------|
|
|
| Architecture | ✅ Up to date | 2025-01-08 |
|
|
| Sprints | 🔴 Pending | - |
|
|
| Analysis | ✅ Up to date | 2024-11-21 |
|
|
| Guides | 🔴 Pending | - |
|
|
| Core Docs | ✅ Up to date | 2025-01-08 |
|
|
|
|
---
|
|
|
|
**Note:** This documentation structure follows best practices for organizing technical documentation in large projects.
|
|
|