Skip to content

README: hero, web app screenshots, architecture diagram, and live counts - #213

Merged
emmanuelgjr merged 3 commits into
mainfrom
docs/readme-refresh
Oct 5, 2026
Merged

emmanuelgjr merged 3 commits into
mainfrom
docs/readme-refresh

Conversation

@emmanuelgjr

Copy link
Copy Markdown
Contributor

What this changes

A presentation pass on README.md, plus five screenshots of the web app. No mapping data, script or webapp file changes.

  • Hero. The live home page is the lead image, followed by a one-line pitch and a link row to the app's main pages. This replaces the old ## heading made of links. Badges, the quote and the creator line are unchanged.
  • Contents line under the hero.
  • See it in action (new). A 2×2 gallery: Explorer, a framework view (MITRE ATLAS), Score with six frameworks selected, and Incidents. Each image links to its live page, and the captions say what each page is for. A note dates the screenshots, since their counts will age.
  • How it fits together (new). A Mermaid flowchart showing the three inputs (mapping files, registries, incidents), generate.js, and what each output reads. I checked it against the scripts: the STIX export reads data/incidents.json directly, and the control exports read the entries and registries.
  • Folded with <details>: Repository structure (about 140 lines) and Quick navigation. Their contents are unchanged.
  • Stale hand-typed counts now use stats markers, so stats:check keeps them current:
    • "50 incidents" in four places → 147
    • "14 more frameworks" → the mapped-framework count
    • the Source lists table's 23 / 23 / 21 → 26 / 26 / 24
  • Agentic Skills Top 10 now reads "1 (MAESTRO, DRAFT rows only)" instead of "mappings pending".
  • A pre-existing rendering bug: in the TL;DR, a line that began with a stats marker was parsed as raw HTML, so "26 industry frameworks" broke into its own paragraph. The marker no longer starts the line.

Screenshots

  • Stored in .github/assets/screenshots/ (about 800 KB total), deliberately outside docs/, so the deployed webapp tree is untouched (C2).
  • Taken on 2026-10-05 from main (591b13b), with headless Chrome against docs/ served locally at 1440 px wide.
  • The home shot is cropped to the hero, because the section below it carries stale webapp copy (see "Found while doing this").

Lint

MD033 (inline HTML) is disabled for README.md only, with a comment saying why. The centred hero, the gallery table and the <details> folds need HTML. The repo-wide config is unchanged.

Verification

  • markdownlint-cli2 0.13.0 (the CI-pinned version): 0 errors across 119 files.
  • render-stats --check and stats:check current; validate 0 errors / 92 warnings (same as main); 94/94 tests; no regen drift.
  • lychee 0.24.2 on README.md: 141 unique links, 0 errors.
  • Rendering on GitHub: checked on this branch's blob page. The hero, gallery, folds and Mermaid diagram all render, the TL;DR sentence is one paragraph, and anchors resolve. A fixed-budget headless capture showed "Unable to render rich display" for the diagram. A real-time load (puppeteer, 15 s wait) renders it correctly, so that was the capture, not the README.

Found while doing this (not changed here)

  1. docs/banner.svg is stale and wasn't used. It's frozen at 25 frameworks, 1,514 controls, 41 entries, 114 incidents, with an old repo URL. It also carries the creator's name, which C1 limits to README.md and the About page. It's a webapp asset, so a fix needs C2 approval.
  2. The webapp home page's "How to Use This" copy is stale: "Search 41 OWASP entries … all 25 framework mappings" (live: 51 and 26). C2 webapp content.
  3. Translated READMEs (i18n/de, es, ja) are not updated here.

🤖 Generated with Claude Code

emmanuelgjr and others added 3 commits October 5, 2026 06:21
- Hero: the live home page as the lead image, a one-line pitch, and a link
  row to the web app's main pages (replacing the heading made of links).
- "See it in action": four screenshots (Explorer, a framework view, Score with
  six frameworks selected, Incidents), each linked to its page. Taken on
  2026-10-05 from main, with headless Chrome against docs/ served locally.
  They are stored in .github/assets/screenshots/, outside the deployed
  webapp tree.
- "How it fits together": a Mermaid flowchart of the three inputs, generate.js,
  and what each export reads.
- A contents line; Repository structure and Quick navigation fold into
  <details>.
- Stale hand-typed counts now use stats markers: "50 incidents" (4 places,
  now 147), "14 more frameworks", and the source-list table's 23/23/21
  (now 26/26/24). Agentic Skills Top 10 shows its one DRAFT framework.

docs/banner.svg is not used: it is frozen at 25 frameworks / 1,514 controls /
41 entries / 114 incidents. MD033 is disabled for README.md only.

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

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@emmanuelgjr
emmanuelgjr merged commit 93b9cad into main Oct 5, 2026
6 checks passed
@emmanuelgjr
emmanuelgjr deleted the docs/readme-refresh branch October 5, 2026 10:42
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