Skip to content

Redraw Fixed Branches and Split Wide Charts in ARCHITECTURE.md - #1131

Merged
ptr727 merged 7 commits into
developfrom
feature/1107-architecture-docs
Oct 31, 2026
Merged

ptr727 merged 7 commits into
developfrom
feature/1107-architecture-docs

Conversation

@ptr727

@ptr727 ptr727 commented Oct 31, 2026 •

Copy link
Copy Markdown
Owner

Summary

Bring ARCHITECTURE.md "Process Command Logic" in line with the fixes merged to develop in this run, and split the wide charts.

  • Remove every "Suspect Branches" entry the merged fixes closed (S6, S7, S9, S10, S11, S12, S13, S14), and redraw each affected chart to the behavior that shipped:
    • Run Flow: a failed settings or results write is logged, DeleteEmptyFolders() still runs, and process returns 1. Monitor keeps running.
    • Dispatch and Results: RegisterInvalidFiles() skips deleted files, prunes entries whose file is gone from a folder that exists, and retries a failed settings write.
    • Per-File Pipeline: a rename or remux target that holds another file fails the file without deleting it, and a sidecar delete failure no longer undoes FileDeleted.
    • Sidecar Refresh: the tool-change sense of IsMediaAndToolsCurrent(), tool versions recorded only when the tools rerun, and the seeded state merged back after a sidecar read.
    • Convert.ReMuxToMkv(): the move overwrites only the input itself.
    • RemoveCoverArt(): the MediaInfo-only path, the re-check, and the RemovedCoverArt guard against repeating.
    • Metadata repair: ReportUnrepairedMetadataErrors() and the flags-did-not-stick guard.
    • Deinterlace and Re-Encode: the process command skips a file already DeInterlaced or ReEncoded.
    • Command gates: the option and state checks the standalone remux, removeclosedcaptions, deinterlace, and reencode commands skip are marked as process-only.
    • Verify and Repair: BitrateExceeded set or cleared from every measurement, a tool error leaves Verified unset, re-measure after a re-encoding repair, and the failed packet analysis paths.
    • State Flags by Step: VerifyAndRepair() clears BitrateExceeded, and the rename note.
  • Split "Remux and Container Steps" into one flowchart TD block per step, each with a one-line lead. Edges that pointed into the shared remux subgraph end on a terminal Convert.ReMuxToMkv() node.
  • Split "Track Selection" the same way. "Metadata and Structure Repair" stays one chart.

Verification

  • Full test suite passes, including ArchitectureDiagramTests.
  • Every mermaid block under "Process Command Logic" parses with mermaid 11.4.1.
  • markdownlint-cli2, CSpell, and the prose lint pass.

Pre-existing findings, not filed

  • ARCHITECTURE.md "Verify and Repair", node FAIL "Fail, state unchanged" and the matching prose, pre-existing: on a ToolError or cancel the sidecar state is unchanged, but VerifyBitrate() can already have set or cleared BitrateExceeded in memory, which reaches the result row.

Closes on promotion: #1107

🤖 Generated with Claude Code

ptr727 and others added 3 commits October 31, 2026 08:19
Remove every Suspect Branches entry the fixes merged to develop closed,
and redraw each affected chart to the behavior that shipped. Split the
Remux and Container Steps and Track Selection charts into one block per
step so each renders at full page width.

Closes on promotion: #1107

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Say which Convert.ReMuxToMkv() overload the remux chart draws, mark the
deinterlace and re-encode gates the standalone commands skip, and draw
the cover art skip as the leftover it tracks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
State that the cover art and track flag repeat guards persist across
runs only with UseSidecarFiles on, that a changed media hash replaces
the stored flags on a rename, and which option and state gates the
standalone remux and caption commands skip.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings October 31, 2026 15:40
@coderabbitai

coderabbitai Bot commented Oct 31, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 17 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

Learn how review limits work.

Review configuration:

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 367d73ab-9eb1-4871-a5cf-7a8cd761546d
Commits

Reviewing files that changed from the base of the PR and between 2ea0cfd and 80f02ca.

Files selected for processing: 1
  • ARCHITECTURE.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@ptr727

ptr727 commented Oct 31, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head e41d50a98899b9ada4dc75107e649eaf655eaf15, the content this pull request carries at that commit against develop, and it recorded 1 finding.

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can keep summaries lean with Findings visible per group, which tucks the rest behind a View link

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Redraw Process Command Logic and Split Wide Architecture Charts

📝 Documentation 🕐 20-40 Minutes

Grey Divider

AI Description

• Align Process Command Logic diagrams with the fixes shipped for failures, state flags, and command
 gates.
• Split wide remux and track-selection charts into per-step diagrams for easier reading.
• Remove resolved suspect-branch entries and clarify sidecar-dependent behavior.
Diagram

graph TD
  DOC["Process logic docs"] --> RUN["Run flow"] --> DIS["Dispatch results"] --> PIPE["Per-file pipeline"] --> VERIFY["Verify repair"] --> FLAGS["State flags"]
  PIPE --> SIDE["Sidecar refresh"] --> FLAGS
  PIPE --> STEPS["Remux and tracks"] --> FLAGS
Loading
High-Level Assessment

Keep the per-step charts: they make the previously wide diagrams readable without changing the document’s structure. Before merging, qualify the VerifyBitrate() prose as noted in the PR’s open finding: early returns do not clear BitrateExceeded.

Files changed (1) +175 / -87

Documentation (1) +175 / -87
ARCHITECTURE.mdDocument shipped process behavior in smaller Mermaid charts +175/-87

Document shipped process behavior in smaller Mermaid charts

• Redraws run, per-file, sidecar, remux, metadata, command-gate, and verification branches to reflect the merged fixes. Splits remux and track-selection charts by step, updates state-flag notes, and removes resolved suspect-branch entries.

ARCHITECTURE.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The change still has three active documentation issues that misstate failure handling and monitoring behavior, so the control-flow diagrams and bitrate claim need correction.

3 open issues
What changed in this PR

This documentation-only PR updates ARCHITECTURE.md to reflect recently merged processing fixes and restructures wide Mermaid diagrams for readability.

Changes:

  • Updates processing-flow documentation for write failures, retries, sidecar state, metadata repair, verification, and command-specific behavior.
  • Splits Remux/Container and Track Selection diagrams into focused per-step charts.
  • Removes resolved suspect-branch entries and updates state-flag documentation.
File Description Review findings
ARCHITECTURE.md Synchronizes architecture documentation with current implementation behavior and restructures Mermaid charts. [P1] Split the collision path from the successful move so a failed ReplaceInput() does not flow to input deletion. (nit, 2 votes)

[P1] Make packet-analysis branches exclusive by labeling the edge to lossless repair as the successful analysis path. (nit, 1 vote)

[P1] Limit the BitrateExceeded clearing claim to successful measurements; skipped or failed analysis leaves it unchanged. (nit, 4 votes)

[P2] Update unrepaired-metadata reporting to cover both disabled flag repair and non-converging repair paths. (nit, 1 vote)

[P2] Qualify the no-repeat cover-art claim for cases where MkvMerge continues detecting cover art. (nit, 1 vote)

[P2] Scope the write-failure branch to the process command so monitor behavior remains accurate. (nit, 2 votes)

[P2] Remove the obsolete suspect-branch section and update the related convention and navigation references. (nit, 1 vote)

[P2] Limit the retry claim to monitor batches rather than standalone process execution. (nit, 1 vote)

[P2] Distinguish seeded rename state from stored flags when media changes. (nit, 1 vote)

Review effort: Lite

Comment thread ARCHITECTURE.md Resolved
Comment thread ARCHITECTURE.md Resolved
Comment thread ARCHITECTURE.md Resolved
ptr727 and others added 2 commits October 31, 2026 08:46
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ptr727

ptr727 commented Oct 31, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head e778961e96c3818ae690fac3f5b50c9714758dd3, the content this pull request carries at that commit against develop, and it recorded 1 finding.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ptr727

ptr727 commented Oct 31, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head 80f02ca81c1f0424946bc0b05570f4478ba6bac1, the content this pull request carries at that commit against develop, and it recorded 1 finding.

@ptr727
ptr727 merged commit 4bf11e8 into develop Oct 31, 2026
14 checks passed
@ptr727
ptr727 deleted the feature/1107-architecture-docs branch October 31, 2026 16:09
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.

2 participants