Welcome to the JJB Gallery documentation. This directory contains comprehensive documentation organized by category.
cd docs # pwd: Documents/docs├── README.md # Main documentation index
├── ORGANIZATION.md # Organization guide
├── QUICK_START.md # Quick start guide
│
├── setup/ # Setup & Configuration
│ ├── NPM_SETUP.md
│ ├── STORAGE_CONFIGURATION.md
│ ├── EXTERNAL_STORAGE_SETUP.md
│ ├── EXTERNAL_STORAGE_COMPLETE.md
│ ├── pip.conf.README.md
│ └── dependencies.md
│
├── deployment/ # Production Deployment (New)
│ ├── PRODUCTION_DEPLOYMENT.md # Main production guide
│ ├── DOCKER.md # Docker deployment guide
│ └── KUBERNETES.md # Kubernetes deployment guide
│
├── architecture/ # Architecture Documentation (New)
│ └── OVERVIEW.md # System architecture overview
│
├── development/ # Development Guides
│ ├── GIT_PROTOCOL_GUIDE.md
│ └── REMOTE_PYTHON_PATHS.md
│
├── security/ # Security Documentation
│ ├── SECURITY.md # Security policy
│ └── PRODUCTION_HARDENING.md # Production hardening (New)
│
├── monitoring/ # Monitoring & Observability (New)
│ └── SETUP.md # Monitoring setup guide
│
├── scripts/ # Script Documentation
│ ├── scripts.md
│ └── npm-README.md
│
└── projects/ # Project-Specific Docs
└── crewai/
├── LLM_SETUP.md
├── TEST_INSTRUCTIONS.md
└── TOOLS_SUMMARY.mdGuides for setting up and configuring the repository and its dependencies.
- Quick Start Guide - Get started quickly
- NPM Setup & Integration - NPM package configuration
- Storage Configuration - External storage setup
- External Storage Setup - Detailed storage setup
- External Storage Complete - Complete storage guide
- Pip Configuration - Python pip configuration
- Dependencies - Dependency management
Comprehensive guides for deploying applications to production environments.
- Production Deployment Guide - Best practices and strategies
- Docker Deployment - Containerization and deployment
- Kubernetes Deployment - Orchestration and scaling
High-level system design and component interaction documentation.
- Architecture Overview - System design and data flow
Guides for ensuring system health and performance.
- Monitoring Setup - Logging, metrics, and alerting configuration
Development guides and technical documentation.
- Git Protocol Guide - Git and GitHub setup
- Remote Python Paths - Remote Python environment configuration
Security policies and best practices.
- Security Policy - Security reporting and policies
- Production Hardening - Securing production deployments
Documentation for repository scripts and automation.
- Scripts Overview - All repository scripts
- NPM Scripts - NPM-related scripts and tools
Project-specific documentation.
- LLM Setup - LLM provider configuration
- Test Instructions - Testing guide
- Tools Summary - Available tools overview
- Read the Quick Start Guide
- Configure Storage
- Set up NPM
- Review Production Deployment Guide
- Consult Security Hardening
- Set up Monitoring
- Review Git Protocol Guide
- Check Remote Python Paths if using remote environments
- See individual project READMEs in
projects/directory - Check CrewAI documentation for multi-agent system
When adding new documentation:
- Place files in the appropriate subdirectory
- Update this README with links
- Follow existing naming conventions
- Include clear headings and examples