Merged in feature/permit-policy-cleanup (pull request #210)
cleanup permit policies and correct documentation * docs * policy cleanup * refactor * Merge remote-tracking branch 'origin/feature/permit-policy-cleanup' into feature/permit-policy-cleanup * docs and edits
This commit is contained in:
@@ -15,7 +15,7 @@ This documentation provides comprehensive coverage of the DoczyAI Document Proce
|
||||
- Deployment architecture and scalability
|
||||
|
||||
2. **[Service Architecture](02-service-architecture.md)**
|
||||
- Detailed service catalog (8 services)
|
||||
- Detailed service catalog (active + compatibility services)
|
||||
- Document processing pipeline flow
|
||||
- Inter-service communication patterns
|
||||
- Queue architecture and message formats
|
||||
@@ -63,7 +63,7 @@ This documentation provides comprehensive coverage of the DoczyAI Document Proce
|
||||
- Token types and refresh strategy
|
||||
- CORS configuration
|
||||
|
||||
10. **[Appendix](10-appendex.md)**
|
||||
10. **[Appendix](10-appendix.md)**
|
||||
- S3 Storage Guide: BucketKey path format, segment reference, partitioning
|
||||
- Watching S3 for client document imports
|
||||
- Document recovery from S3 buckets
|
||||
@@ -92,20 +92,20 @@ This documentation provides comprehensive coverage of the DoczyAI Document Proce
|
||||
|
||||
### 🏗️ Architecture
|
||||
- **Event-driven microservices** with SQS-based communication
|
||||
- **8 distinct services**: 1 HTTP API + 6 runners + 1 utility
|
||||
- **Active services**: 1 HTTP API + 5 active runners
|
||||
- **Compatibility services**: additional deprecated runner binaries may still be present in some deployments
|
||||
- **Multi-tenant design** with client isolation
|
||||
- **Comprehensive versioning** for configurations
|
||||
|
||||
### 🔧 Technology Stack
|
||||
- **Backend**: Go 1.24.0 with Echo framework
|
||||
- **Database**: PostgreSQL 17.2 with SQLC
|
||||
- **Cloud**: AWS (S3, SQS, Textract, Cognito)
|
||||
- **Cloud**: AWS (S3, SQS, Cognito)
|
||||
- **Containers**: Docker with multi-stage builds
|
||||
- **Monitoring**: Prometheus + OpenTelemetry
|
||||
|
||||
### 📊 Key Capabilities
|
||||
- **Document Processing**: PDF upload, cleaning, and text extraction
|
||||
- **Text Extraction**: Automated OCR with AWS Textract
|
||||
- **Document Processing**: PDF upload, initialization, sync-gating, and cleaning
|
||||
- **Multi-tenant Support**: Isolated client environments
|
||||
- **Document Organization**: Folders and labels for document management
|
||||
- **Export Operations**: Structured data export in multiple formats
|
||||
@@ -246,10 +246,10 @@ This workflow ensures all documentation formats are current with proper diagram
|
||||
- **Health Checks**: http://localhost:8080/health
|
||||
|
||||
### External Dependencies
|
||||
- **AWS Services**: S3, SQS, Textract, Cognito
|
||||
- **AWS Services**: S3, SQS, Cognito
|
||||
- **Database**: PostgreSQL 17.2+
|
||||
- **Monitoring**: Prometheus-compatible metrics
|
||||
|
||||
---
|
||||
|
||||
*This documentation is automatically generated and maintained alongside the codebase. For questions or improvements, please contact the platform team.*
|
||||
*This documentation is automatically generated and maintained alongside the codebase. For questions or improvements, please contact the platform team.*
|
||||
|
||||
Reference in New Issue
Block a user