Skip to content

The README shows how cdclint is put together in one diagram - #30

Merged
avison9 merged 1 commit into
mainfrom
docs/architecture-diagram
Nov 14, 2026
Merged

avison9 merged 1 commit into
mainfrom
docs/architecture-diagram

Conversation

@avison9

@avison9 avison9 commented Nov 14, 2026

Copy link
Copy Markdown
Owner

Merge after #28 and #29. The diagram lists replica-identity, which arrives in #29.

What changes

  • docs/diagrams/architecture.svg, a hand-written SVG in the style of the diagrams in avison9/warmbench. Top to bottom:
    1. the five inputs, read as files (the optional ones dashed);
    2. the four readers, in line with their inputs;
    3. one model;
    4. Resolve, the only accent: every sink column matched to the source column it expects, which is where a dropped column is caught;
    5. the rules, in three groups, each titled with the question it answers;
    6. cdclint:ignore decisions;
    7. the output: a real finding from the README's "Try it" example, and exit 1 fails the pull request.
  • README: the diagram and three sentences at the top of "What it checks", above the rules table.

Verified

Rejected

Mermaid, which GitHub renders natively. Its automatic layout crossed edges and broke rule names at their hyphens, and it did not read as cleanly as this. The SVG is still plain text and can be edited.

For you

Look at it in the PR's rich diff of README.md before merging.

docs/diagrams/architecture.svg, embedded at the top of "What it checks":
the five inputs read as files, the four readers in line with them, one
model, the resolve step that matches every sink column to the source
column it expects (the one accent, because that is where a dropped
column is caught), the rules grouped by the question each answers,
cdclint:ignore decisions, and the output with its exit code.

Hand-written SVG in the style of the diagrams in avison9/warmbench, so
it stays editable as text and renders the same on GitHub as anywhere
else. Rejected: Mermaid. It renders natively on GitHub, but its
automatic layout crossed edges and wrapped rule names at their hyphens,
and the result did not read as cleanly.

It lists replica-identity, which arrives in #29; merge this after #28
and #29.
@avison9 avison9 self-assigned this Nov 14, 2026
@avison9
avison9 merged commit 5a2ccfa into main Nov 14, 2026
2 checks passed
@avison9
avison9 deleted the docs/architecture-diagram branch November 14, 2026 16:51
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