Skip to content

fix(patterns) redraw ten more ASCII diagrams under 78 columns - #435

Merged
mjmirza merged 3 commits into
mainfrom
fix/diagram-width-batch-12
Aug 24, 2026
Merged

fix(patterns) redraw ten more ASCII diagrams under 78 columns#435
mjmirza merged 3 commits into
mainfrom
fix/diagram-width-batch-12

Conversation

@mjmirza

@mjmirza mjmirza commented Aug 24, 2026

Copy link
Copy Markdown
Owner

Summary

  • Redraws ten more ASCII diagrams that exceeded 78 characters wide,
    the next tier at 80 characters, down to 50 to 62 characters.
  • unit-of-work.md, claim-check.md, polling-consumer.md,
    log-deployments-changes.md, microservice-chassis.md,
    third-party-registration.md, conformist.md,
    ubiquitous-language.md, lamport-clock.md,
    characterization-test.md.
  • No structural, prose, reference, or code content changed. Only the
    diagram fences.
  • tools/gen-indexes.py was re-run before this commit, regenerating the
    six family index tables these entries span.

Notable redesigns

  • claim-check.md's structure diagram and its own dynamics section
    (section 7) disagreed on where Check-Out sits in the flow. The
    dynamics section is authoritative, the Receiver calls Check-Out to
    resolve the claim check, rather than Check-Out being a parallel
    sibling to Check-In fed directly by the Message Channel. The
    redrawn diagram now matches the dynamics section.
  • unit-of-work.md keeps the distinction between the registered
    variant (a dashed back-reference from Domain Object to Unit of
    Work) and the automatic variant (no such reference, dirtiness
    computed from a load-time snapshot).
  • microservice-chassis.md keeps all four consuming services (Order,
    Payment, Shipping, Catalog) and every chassis module they inherit.

Test plan

  • check-structure.py, 884 of 884 entries pass
  • check-prose.py, 925 of 925 entries pass
  • markdownlint-cli2 0.23.2, 0 issues on the ten changed files
  • validate-refs.py --strict, every citation resolves
  • check-code.py --strict, 2826 compiled, 0 failed, 0 skipped
  • gen-indexes.py re-run, six family README tables regenerated and
    committed alongside the content changes
  • git diff --stat -- docs and dist and the root README.md, all
    empty, no unexpected top level changes

17 more entries with the same width issue remain, to be worked through
in following batches.

Continues the diagram-width review pass. This batch covers the next
tier of offenders, all 80 characters wide, redrawn as narrower
vertical layouts.

- unit-of-work.md, 80 to 55 characters
- claim-check.md, 80 to 61 characters
- polling-consumer.md, 80 to 54 characters
- log-deployments-changes.md, 80 to 50 characters
- microservice-chassis.md, 80 to 53 characters
- third-party-registration.md, 80 to 62 characters
- conformist.md, 80 to 50 characters
- ubiquitous-language.md, 80 to 58 characters
- lamport-clock.md, 80 to 50 characters
- characterization-test.md, 80 to 56 characters

No structural, prose, reference, or code content changed, only the
diagram fences. Every redrawn diagram preserves every field, every
prose annotation, and every before/after framing from the original,
only the visual layout narrowed. claim-check.md's five numbered
steps were re-verified against its own dynamics section (section 7)
before redrawing, since the structure diagram and the sequence
diagram disagreed on where Check-Out sits in the flow. the sequence
diagram is authoritative, and the redrawn structure diagram now
matches it, the Receiver calls Check-Out to resolve the payload,
rather than Check-Out sitting as a parallel sibling to Check-In.
microservice-chassis.md's four consuming services (Order, Payment,
Shipping, Catalog) each keep their full module list.

tools/gen-indexes.py was re-run before this commit, regenerating
the family index tables these ten entries span.

check-structure.py 884/884, check-prose.py 925/925, markdownlint-cli2
0 issues, validate-refs.py --strict all citations resolve,
check-code.py --strict all code blocks still compile.

17 more entries with the same width issue remain, to be worked
through in following batches.
@mjmirza mjmirza added the enhancement New feature or request label Aug 24, 2026
# Conflicts:
#	patterns/12-data-storage/README.md
#	patterns/14-testing/README.md
@mjmirza

mjmirza commented Aug 24, 2026

Copy link
Copy Markdown
Owner Author

REVIEWED. Approve. This is batch 12 of the ASCII-diagram width-remediation pass. Ten
diagram sections redrawn under the 78-column limit, spanning six families
(06, 07, 10, 11, 12, 14).

Real diff confirmed via gh pr diff --name-only. 16 files, 10 content entries
plus 6 family README.md index regenerations, matching the expected shape.

CI. every real check (markdown style, structure and prose, code samples
compile, citations resolve, PR security check) reports pass across both
check-suite runs on this PR. The two "skipping" entries are the claim
check and PR security check on the pre-merge-fix commit, superseded by the
green re-run on the post-merge-fix commit.

Notable fix beyond width. claim-check.md's structure diagram previously
implied Check-Out was a parallel sibling of Check-In fed directly by the
Message Channel. Cross-checked against the pattern's own section 7 dynamics
sequence (Receiver invokes get(key) to resolve the payload) and corrected
the redrawn diagram so Check-Out is shown as triggered by the Receiver, not
as an independent channel consumer. This is a content-fidelity fix, not
only a width reduction.

Merge history. this PR conflicted with batch 11 (PR #434) on two family
READMEs, 12-data-storage/README.md and 14-testing/README.md, since both
batches touched overlapping families in parallel branches. Resolved via
the standard recipe. git fetch, merge origin/main, take main's version on
the conflicted READMEs, regenerate all family indexes fresh via
gen-indexes.py, commit the regeneration separately, push. PR flipped from
CONFLICTING to CLEAN/MERGEABLE and CI re-ran green on the merge-fix commit.

Gate sequence (check-structure.py, check-family-names.py, check-prose.py,
markdownlint-cli2 0.23.2, validate-refs.py --strict, check-code.py
--strict) all ran clean locally before push, and gen-indexes.py was
re-run after the merge-fix so all six family README byte counts reflect
both batch 11 and batch 12 correctly.

Single review pass, low blast radius. pure diagram-fence replacements in
already-published entries, no prose or reference changes outside the
diagram sections and the generated index tables.

@mjmirza
mjmirza merged commit e56a448 into main Aug 24, 2026
12 checks passed
@mjmirza
mjmirza deleted the fix/diagram-width-batch-12 branch August 24, 2026 02:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant