agmission/Development/server/docs/archived/README.md

5.0 KiB
Raw Blame History

Archived Documentation

This directory contains historical documentation that has been superseded but is kept for reference.

Notice

These files are archived and kept for historical reference only.

Current Documentation: See DOCUMENTATION_INDEX.md for the complete documentation structure.

Contents

DLQ System Evolution

  • DLQ_DOCUMENTATION_CONSOLIDATION.md - Initial consolidation effort (superseded)
  • DLQ_IMPROVEMENTS_SUMMARY.md - Early improvements summary (superseded)
  • GLOBAL_DLQ_REFACTORING_COMPLETE.md - Global refactoring milestone (superseded)
  • REFACTORING_SUMMARY.md - General refactoring summary (superseded)

Partner DLQ System (Legacy)

  • PARTNER_DLQ_*.md - Original partner-specific DLQ implementation
  • partner_dlq.js - Legacy DLQ controller code examples

Current Documentation:

Initial Design Specification Docs (Archived Feb 2026)

These docs were written as forward-looking design specs during the JulAug 2025 architecture phase. They contain invented components (PartnerRegistry, syncState schema, SYNC_PARTNER_DATA task, downloadLogFile() method, etc.) that were never implemented as described. Archived to prevent confusion with the actual implementation.

  • IMPLEMENTATION_GUIDE.md — Original step-by-step implementation spec (Partner Registry, TypeScript interfaces)
  • DATABASE_DESIGN.md — Design-spec schema with invented syncState/retryConfig fields on JobAssign
  • API_SPECIFICATION.md — Design-spec API reference with invented endpoint shapes and syncState response bodies
  • MONITORING_GUIDE.md — Monitoring design spec using non-existent partnerRegistry.getAll()
  • WORKER_RESPONSIBILITIES_UPDATE.md — Stale milestone with wrong queue name (partner_jobs), wrong method (downloadLogFile), wrong task type (PROCESS_PARTNER_DATA_FILE as primary)

Current Documentation: ../PARTNER_INTEGRATION_ARCHITECTURE.md, ../PARTNER_LOG_FILE_PROCESSING.md

Partner Integration Milestones (Archived Feb 2026)

  • PARTNER_SYSTEM_REFACTORING_SUMMARY.md — Jul 2025: RESTful API standardization milestone
  • PARTNER_SYNC_INTEGRATION_SUMMARY.md — Aug 2025: Sync improvements milestone
  • PARTNER_LOG_MIGRATION_SUMMARY.md — Log tracker schema migration history
  • PARTNER_SYNC_WORKER_REFACTORING.md — Worker refactoring milestone

Current Documentation: ../PARTNER_INTEGRATION_ARCHITECTURE.md

SatLoc Implementation Milestones (Archived Feb 2026)

  • SATLOC_COMPLETE_IMPLEMENTATION.md — Implementation completion milestone
  • SATLOC_IMPLEMENTATION_SUMMARY.md — Implementation summary
  • SATLOC_INTEGRATION_SUMMARY.md — Integration summary
  • SATLOC_TESTING_SUMMARY.md — Testing milestone

These are historical milestones. Active technical SatLoc reference docs remain in docs/: SATLOC_API_SPECIFICATION.md, SATLOC_API_ACTUAL_BEHAVIOR.md, SATLOC_BINARY_PROCESSING_ARCHITECTURE.md, SATLOC_APPLICATION_PROCESSOR_README.md, SATLOC_ERROR_PATTERNS.md, SATLOC_LOG_NOTES.md

Why Archived?

The DLQ system evolved from partner-specific to global architecture:

Before (Archived)

/api/partners/dlq/*  (partner-specific only)

After (Current)

/api/dlq/:queueName/*  (works for ALL queue types)

Benefits:

  • Universal API for all queues (partner_tasks, jobs, notifications)
  • No code changes needed for new queues
  • Cleaner documentation structure
  • No MongoDB coupling (queue-native operations)

Documents are archived when:

  • Implementation has been superseded by newer approach
  • Information is outdated but valuable for historical context
  • Multiple incremental updates consolidated into comprehensive docs

Usage

Reference archived docs to:

  • Understand evolution of system design
  • Review rationale for architecture changes
  • Learn from past implementation attempts
  • Troubleshoot legacy issues in older deployments

Last Updated: January 21, 2026

These files document the old partner-specific implementation:

  • PARTNER_DLQ_API.md - Old API documentation
  • PARTNER_DLQ_API_SUMMARY.md - Old API summary
  • PARTNER_DLQ_ARCHITECTURE_DIAGRAMS.md - Moved to current docs as DLQ_ARCHITECTURE_DIAGRAMS.md
  • PARTNER_DLQ_DEPLOYMENT_CHECKLIST.md - Old deployment guide
  • PARTNER_DLQ_DESIGN_ISSUES_AND_FIXES.md - Historical design issues (now fixed)
  • PARTNER_DLQ_HANDLING.md - Old operations guide
  • PARTNER_DLQ_IMPLEMENTATION.md - Old implementation details
  • PARTNER_DLQ_INDEX.md - Old documentation index
  • PARTNER_DLQ_QUICKSTART.md - Old quick start

Date Archived: December 19, 2025
Reason: Global DLQ architecture refactoring
See: GLOBAL_DLQ_REFACTORING_COMPLETE.md