Skip to content

fix: README Mermaid render + mermaid lint, CI, submissions, style pass#1

Merged
jpantsjoha merged 1 commit into
mainfrom
fix/readme-mermaid-ci-submissions
Jul 23, 2026
Merged

fix: README Mermaid render + mermaid lint, CI, submissions, style pass#1
jpantsjoha merged 1 commit into
mainfrom
fix/readme-mermaid-ci-submissions

Conversation

@jpantsjoha

Copy link
Copy Markdown
Owner

What

Fixes the broken Mermaid diagram on main (GitHub parse error) and closes the gate gap that let it ship.

Why it broke

A ; in a sequenceDiagram message is a statement separator — GitHub's renderer errored on patterns; warn before every billable action. The URL linter never checked Mermaid.

Changes

  • Fix: ;, in the diagram message
  • Prevent: scripts/validate_mermaid.py (dependency-free Mermaid linter) folded into make gate + pre-commit hook; regression-tested against the exact bug
  • README: swapped hero to the wide social banner; Economist style pass; trimmed bio; added "not affiliated with Google" disclaimer
  • CI: gate.yml (runs the gate on PRs) + freshness.yml (weekly drift check → opens an issue)
  • Docs: docs/SUBMISSIONS.md (Claude Plugin Hub / Gemini extensions / awesome lists)

Validation

make gate green: validate + manifest + mermaid + lint + test (136 tests).

…s, style pass

The diagram on main failed to render — a ';' in a sequenceDiagram message is a
statement separator, so GitHub's parser errored. Root fix + prevention:
- README line: 'patterns; warn' -> 'patterns, warn'
- scripts/validate_mermaid.py: dependency-free Mermaid linter (semicolons in
  messages, rect/end balance, participant refs); folded into make gate + hook.
  Regression-tested: catches the exact bug that shipped.

The URL linter never checked Mermaid — this closes that gate gap.

Also:
- README: swapped hero to the wide social banner (assets/images/...by-jp.png);
  Economist style pass (cut 'actually', tighter verbs, semicolon->full stop);
  bio trimmed; added "not affiliated with Google" disclaimer
- CI: .github/workflows/gate.yml (gate on PRs) + freshness.yml (weekly drift
  check, opens an issue on source drift)
- docs/SUBMISSIONS.md: Claude Plugin Hub / Gemini extensions / awesome lists

Gate: validate + manifest + mermaid + lint + test all green
@jpantsjoha
jpantsjoha merged commit 487bd28 into main Jul 23, 2026
1 check passed
@jpantsjoha
jpantsjoha deleted the fix/readme-mermaid-ci-submissions branch July 23, 2026 19:10
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