Skip to content

docs: update architecture doc for inlined polydock libraries#195

Open
dan2k3k4 wants to merge 2 commits into
devfrom
advisor/005-update-architecture-docs
Open

docs: update architecture doc for inlined polydock libraries#195
dan2k3k4 wants to merge 2 commits into
devfrom
advisor/005-update-architecture-docs

Conversation

@dan2k3k4

@dan2k3k4 dan2k3k4 commented Jul 1, 2026

Copy link
Copy Markdown
Member

Updates the architecture documentation to reflect the Polydock libraries now being inlined in the app rather than external Composer packages.

Greptile Summary

This PR updates the architecture documentation to reflect that the Polydock libraries (core, clients, and app implementations) were inlined directly into this repository under app/Polydock/ rather than being consumed as external Composer packages.

  • Replaces all freedomtech-hosting/polydock-* package references with paths under app/Polydock/, and updates the interface implementation claims accordingly.
  • Expands the previously placeholder "Job Processing Architecture" and "Event System" sections with accurate descriptions of the state machine, lifecycle stages, and Laravel events.
  • Corrects the PolydockAppAi class name to PolydockAiApp, matching the actual filename app/Polydock/Apps/Generic/PolydockAiApp.php.

Confidence Score: 5/5

Documentation-only change with no runtime code modified; safe to merge.

All changed content is in a single Markdown documentation file. Key claims were cross-checked against the actual source: PolydockAppInstance does implement PolydockAppInstanceInterface, ProgressToNextStageJob does operate on PolydockAppInstance::$completedStatuses, the branch condition at POST_DEPLOY_COMPLETED matches remoteRegistration || getKeyValue('user-email'), and the upgrade job stubs are confirmed. The PolydockAiApp rename matches the real filename.

No files require special attention.

Important Files Changed

Filename Overview
docs/ARCHITECTURE/README.md Documentation-only update replacing external package references with inlined app/Polydock/ paths; claims verified against actual source files.

Reviews (2): Last reviewed commit: "docs: clarify store app references (not ..." | Re-trigger Greptile

Comment thread docs/ARCHITECTURE/README.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant