Skip to content

docs: modernize the migration architecture diagram - #260

Merged
Mark Brown (markjbrown) merged 2 commits into
mainfrom
markjbrown-modern-migration-diagram
Oct 31, 2026
Merged

Mark Brown (markjbrown) merged 2 commits into
mainfrom
markjbrown-modern-migration-diagram

Conversation

@markjbrown

Copy link
Copy Markdown
Collaborator

Summary

  • Replace media/application_architecture.png with a crisp, light-background diagram using Helvetica typography and restrained blue/purple accents, preserving the existing image path.
  • Show the current architecture accurately: the command-line core discovers and composes extensions through MEF, source records stream asynchronously to the sink as IDataItem instances, and shared contracts keep the core independent of plug-in implementations.
  • Include the editable media/application_architecture.excalidraw source and update the README image description and source link. No application code changes.

Verification

  • Grounded the diagram in ExtensionLoader, RunCommand, source/sink interfaces, concrete extension exports, and the core project references.
  • Exported with the Excalidraw renderer and visually inspected the full 1600 × 1574 PNG and its 422 × 415-pixel portfolio preview.
  • Confirmed the source opens in Excalidraw with all 23 editable elements and bound source/sink labels intact; verified JSON references, PNG integrity, and git diff --check.
  • The portfolio copy and editable source were stored locally before this PR; matching hashes, a successful Jekyll build, and browser rendering were confirmed.

Replace the small architecture graphic with a high-resolution diagram showing MEF composition, asynchronous source-to-sink data flow, and shared contracts. Include editable Excalidraw source and refresh the README alt text.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 0bff30e5-2de8-474f-9633-ced50e5928a3
@markjbrown

Copy link
Copy Markdown
Collaborator Author

Phil Nachreiner (@philnach) This documentation PR is ready to merge once the required approval is recorded. I rechecked head ce916950: all seven CI checks pass and there are no unresolved review discussions.

I inspected the rendered diagram and its editable source, verified the 23 elements and their bindings, checked the README image/source links, and confirmed the MEF loading and asynchronous IDataItem source-to-sink flow against the implementation. No additional changes were needed.

@markjbrown
Mark Brown (markjbrown) merged commit 7b87d27 into main Oct 31, 2026
10 checks passed
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