This directory contains comprehensive documentation for the PyFlowGraph project, organized following BMAD-inspired structure with clear separation between user documentation, developer resources, and technical references.
- User Guide - Getting started, tutorials, and examples
- Getting Started - Installation and first workflow
- Tutorials - Step-by-step guides
- Examples - Sample workflows and use cases
- Developer Guide - Development environment and contribution guidelines
- Testing Guide - Test runner and testing strategies
- Implementation Notes - Technical priorities
- AI Agents Guide - Working with AI assistants
- Reference - Complete technical documentation
- Architecture - System design and technical architecture
- Specifications - Feature and interface specifications
- API - API documentation (planned)
- Project - Strategic planning and development tracking
- Issues - Bug reports and issue resolution
- Active Issues - Current unresolved issues
- Resolved Issues - Completed issue resolutions
- Implementation - Detailed implementation plans and fixes
- Fixes - Specific fix implementations
- Migration Plans - Code reorganization plans
This documentation structure follows industry best practices with clear separation of concerns:
Practical guides for end users, including tutorials, examples, and getting started materials.
Technical development information for contributors, including testing, setup, and implementation guidance.
Comprehensive technical specifications, architecture documentation, and API references for detailed technical understanding.
Strategic documents, planning materials, and development tracking for stakeholders and project coordination.
Structured bug tracking and issue resolution with proper categorization and documentation.
Specific implementation plans, migration strategies, and detailed technical solutions.
When adding new documentation:
- Place user-focused content in
user_guide/ - Place developer information in
developer_guide/ - Place technical specifications in
reference/ - Place strategic content in
project/ - Place bug reports in
issues/ - Place implementation details in
implementation/ - Always update relevant README files with new document links
- Follow existing naming conventions and organization patterns
- Each major section has its own README with detailed navigation
- Related documents are cross-referenced for easy discovery
- Status information is maintained for active development items
- Historical documents are preserved in appropriate subdirectories