Skip to content

Update outdated architecture and phase documentation #351

Description

@groupsky

Problem

Architecture and phase documentation mark features as "(future)" or "NEXT" that are already implemented in production.

Discovered during aspected review of #347 fix.

Outdated Documentation

1. docs/ARCHITECTURE.md

Line 9: "Polling Scheduler - Coordinates polling across devices (future)"

  • ❌ OUTDATED - PollingScheduler is implemented in src/polling-scheduler.ts

Line 26: "modbus/{deviceId}/data - Device data publications (future)"

  • ❌ OUTDATED - Data publishing is implemented in src/index.ts lines 68-84

2. docs/PHASES.md

Lines 23-261: Shows Phase 2 as "NEXT" but many features are implemented:

  • ❌ Driver loading - IMPLEMENTED
  • ❌ Device connection - IMPLEMENTED
  • ❌ Polling system - IMPLEMENTED
  • ❌ Data publishing - IMPLEMENTED

Line 250: "Phase 1: ✅ Complete (PR #86)"

  • ⚠️ Needs update - Phase 2 features are partially/fully complete

Impact

  • Confusing for new contributors
  • Makes it unclear what features are production-ready vs planned
  • Misrepresents current project state
  • Could lead to duplicate implementation efforts

Expected Updates

ARCHITECTURE.md

  • Remove "(future)" markers from implemented features
  • Add implementation references (file:line)
  • Mark truly future features clearly

PHASES.md

  • Update Phase 2 status to reflect implemented features
  • Mark completed items with ✅
  • Add completion dates/PR references
  • Create Phase 3 if needed for remaining work

Files Affected

  • docs/ARCHITECTURE.md
  • docs/PHASES.md
  • Possibly packages/mqtt-bridge/docs/ARCHITECTURE.md

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpriority:mediumMedium prioritytype:docsDocumentation improvements

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions