docs: C4 architecture hero diagram + mermaid-lint gate#76
Merged
Conversation
README: add a Mermaid C4Container hero (request flow: browser → servlet container → index.html / InfoServlet → index.jsp) directly under the description. Every node/relationship is grounded in the code — InfoServlet is mapped at /infoservlet and forwards to index.jsp via RequestDispatcher; index.jsp renders server info, request headers, and cookies; index.html is the welcome page; the javax/jakarta split is the two profile-selected source trees. Makefile: add `mermaid-lint` (minlag/mermaid-cli, GitHub's own renderer, Renovate-pinned) and wire it into `static-check` so a broken diagram fails CI instead of silently breaking README rendering on github.com. Verified: the valid diagram passes; an invalid diagram type / garbage body both fail the gate (Error 1). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Validated the README against the codebase fact-by-fact (all claims correct) and added the one missing piece per the
/readmecanonical structure — a hero architecture diagram.README fact-check (all ✓)
/infoservlet, welcomeindex.html, context path/— matchweb.xml/web-jakarta.xml/context.xml.InfoServletforwards toindex.jsp(verifiedRequestDispatcher);index.jsprenders all three.pom.xml,ci.yml,Makefile,images/.Added
C4Containerhero under the description: browser → servlet container (Tomcat 9/10/11 or Jetty) →index.html/InfoServlet→index.jsp. Every node + relationship is grounded in source.make mermaid-lint(minlag/mermaid-cli11.15.0, GitHub's own renderer, Renovate-pinned) wired intostatic-check— a broken diagram now fails CI instead of silently breaking README rendering on github.com.Verification
make mermaid-lintpasses on the diagram; proven to fail on an invalid diagram type / garbage body (Error 1) — not a false-confidence gate.make cigreen end-to-end withmermaid-lintinstatic-check./repo-about
The About one-liner ("Drop-in ROOT webapp for Tomcat 9, 10 & 11 — server info, headers, cookies; one codebase spans the javax→jakarta split via Maven profiles") was fact-checked against the same sources — every claim holds. No change needed.
🤖 Generated with Claude Code