Skip to content

Split the Remux and Container Steps Diagram into Narrower Charts #1107

Closed

Description

@ptr727

Behavior

The ARCHITECTURE.md "Remux and Container Steps" section draws one flowchart TD holding six unconnected flows: the Convert.ReMuxToMkv() subgraph, RemuxByExtension(), RemuxNonMkvContainer(), RemuxRemoveExtraVideoTracks(), RemoveCoverArt(), and RemoveTags(). Mermaid lays separate top-down flows out side by side. The chart therefore renders very wide, and once scaled down to fit the page the text is too small to read.

Fix direction

Unfold the chart into several smaller charts, one per step or one per small group of related steps, so each chart gets the full page width:

  • Convert.ReMuxToMkv() on its own, since three steps call it.
  • RemuxByExtension(), RemuxNonMkvContainer(), and RemuxRemoveExtraVideoTracks(), either together or each on its own. Each ends on a reference to the remux, rather than drawing the subgraph again.
  • RemoveCoverArt() on its own, which is the longest flow.
  • RemoveTags() and RemoveAttachments() together.

Give each chart a short lead sentence naming the step it draws. Keep the node text, the suspect class markings, and the S-number references that "Suspect Branches" links to unchanged, so that only the layout moves. Confirm that each chart renders readably on GitHub at normal page width.

Check the other sections in ARCHITECTURE.md for the same pattern of several unconnected flows in one chart. If any has it, unfold those charts the same way in the same pull request.

Activity

  1. ptr727 commented on Oct 31, 2026

    @ptr727
    OwnerAuthor

    Decision from the maintainer (2026-10-30): keep top-down layout and split "Remux and Container Steps" into one mermaid block per step, each with a one-line lead, with edges into the shared remux subgraph ending on a labelled node. Split "Track Selection" the same way. Leave the two-flow "Metadata and Structure Repair" chart. This lands in the final docs pull request of this run.

  2. ptr727 commented on Oct 31, 2026

    @ptr727
    OwnerAuthor

    Claim (backlog burndown final docs round): branch feature/1107-architecture-docs, file ARCHITECTURE.md only. This pull request also removes the "Suspect Branches" entries and redraws the diagrams for the fixes merged in this run (#1073, #1074, #1076, #1077, #1078, #1079, #1080, #1081, #1082, #1109).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions