Skip to content

docs: add README overview hero image (#211) - #212

Merged
miso-develop merged 1 commit into
mainfrom
task/211
Sep 18, 2026
Merged

miso-develop merged 1 commit into
mainfrom
task/211

Conversation

@miso-develop

@miso-develop miso-develop commented Sep 18, 2026

Copy link
Copy Markdown
Owner

Closes #211
Related: #192

Implementation

  • commit the exact Human-approved JPEG once at docs/assets/m5authenticator-overview.jpg
  • preserve the supplied file byte-for-byte
  • insert ![M5Authenticator overview](docs/assets/m5authenticator-overview.jpg) immediately below the language selector in README.md
  • insert ![M5Authenticatorの概要](docs/assets/m5authenticator-overview.jpg) at the same structural location in README.ja.md
  • preserve all other README content unchanged

Approved asset identity

Source verification before commit:

  • JPEG
  • 840 × 420
  • 122,915 bytes
  • SHA-256: 215ed9c6ffe29ec7ba302dc830569286b188bcfb3c9885f4e4b8b48be3556b42
  • Git blob SHA: 6737e4d5a2a9e7a79f770477c1185597e5344b35

The committed GitHub blob SHA is exactly 6737e4d5a2a9e7a79f770477c1185597e5344b35, proving the repository asset is byte-for-byte the approved upload. No crop, redraw, regeneration, re-encoding, recoloring, or metadata transformation was performed.

Scope

Effective diff is limited to:

  • docs/assets/m5authenticator-overview.jpg
  • README.md
  • README.ja.md

No SECURITY.md, AGENTS.md, product code, Web runtime, firmware, release workflow, or repository About metadata changes.

Human Gate

#211 requires an exact-head Human Gate after independent Review and before Integration merges.

The Human Gate must verify GitHub-rendered EN/JA README views on the exact candidate HEAD. Any subsequent HEAD change invalidates the prior Human Gate and requires re-validation.

Exact-head verification

HEAD: 6de536c9be8c2327473295f4357dd9d98c9c0a69

  • Security #940: SUCCESS — tracked repository security scan and existing release/security contracts passed with the JPEG binary addition.
  • Foundation #937: SUCCESS — Web, Windows Chrome, firmware regression/security contracts, isolated ESP-IDF build, package validation, and dependency-lock verification all passed.
  • committed image blob is exactly 6737e4d5a2a9e7a79f770477c1185597e5344b35, matching the approved upload byte-for-byte; repository fetch confirms 122,915 bytes.
  • source image verification before commit: JPEG, 840 × 420, SHA-256 215ed9c6ffe29ec7ba302dc830569286b188bcfb3c9885f4e4b8b48be3556b42.
  • README.md and README.ja.md each place the required image immediately after the language selector with the required alt text.
  • effective diff is exactly the two README files plus docs/assets/m5authenticator-overview.jpg.
  • current main remains d575e70fd7e07e9f2774762b5636cb74e94ed42d; branch is behind 0 and PR is mergeable.
  • no overlapping open PR exists.

Integration gate

Independent Review is next. After Review passes, Integration must stop for the exact-head Human Gate required by #211 before merge. Human validation applies only to this exact HEAD; any later head change invalidates it.

@miso-develop
miso-develop marked this pull request as ready for review September 18, 2026 17:41

Copy link
Copy Markdown
Owner Author

Implementation for #211 is complete at exact HEAD 6de536c9be8c2327473295f4357dd9d98c9c0a69.

Asset verification:

  • approved upload: JPEG, 840 × 420, 122,915 bytes
  • SHA-256: 215ed9c6ffe29ec7ba302dc830569286b188bcfb3c9885f4e4b8b48be3556b42
  • committed Git blob SHA: 6737e4d5a2a9e7a79f770477c1185597e5344b35
  • GitHub repository fetch confirms the committed blob is 122,915 bytes and the Git blob SHA matches the approved source exactly
  • no crop, redraw, regeneration, re-encoding, recoloring, or metadata transformation was performed

README verification:

  • EN image is immediately below the language selector with alt text M5Authenticator overview
  • JA image is at the same structural location with alt text M5Authenticatorの概要
  • both reference the same repository-relative docs/assets/m5authenticator-overview.jpg
  • diff is limited to the one JPEG plus README.md and README.ja.md

Exact-head CI:

  • Security #940: SUCCESS
  • Foundation #937: SUCCESS
  • current main: d575e70fd7e07e9f2774762b5636cb74e94ed42d
  • branch behind 0; PR mergeable; no overlapping open PR

#211 still requires the explicit exact-head Human Gate after independent Review and before Integration merges. Any later HEAD change invalidates that Human Gate. Implementation has not merged this PR.

Copy link
Copy Markdown
Owner Author

HANDOFF
FROM: implementation
TO: review
DOMAIN: infra
ISSUE: #211
PR: #212
HEAD: 6de536c
STATE: READY_FOR_REVIEW

@miso-develop miso-develop left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review disposition: HUMAN_GATE_REQUIRED

Reviewed exact PR head 6de536c9be8c2327473295f4357dd9d98c9c0a69 against Issue #211 and the #192 product-facing README baseline.

No blocking implementation finding identified.

Approved asset identity — independently verified from the committed repository blob:

  • Path: docs/assets/m5authenticator-overview.jpg.
  • Git blob SHA: 6737e4d5a2a9e7a79f770477c1185597e5344b35.
  • Decoded byte size: exactly 122,915 bytes.
  • JPEG SOI/EOI structure: valid.
  • Dimensions parsed from the JPEG frame: exactly 840 × 420.
  • Independently recomputed SHA-256: 215ed9c6ffe29ec7ba302dc830569286b188bcfb3c9885f4e4b8b48be3556b42.
  • These values exactly match the Human-approved source-asset identity recorded in #211.
  • Therefore the committed binary is byte-for-byte the approved asset; no crop, redraw, regeneration, re-encoding, recoloring, or substitution occurred.
  • The JPEG contains only a small EXIF APP1 block with three numeric TIFF entries; there is no EXIF ASCII/string field, JPEG COM segment, or APP13 metadata carrying a local path/comment/private filesystem string.
  • Repository Security scan is green with this binary addition.

README placement/content:

  • README.md inserts exactly:
    ![M5Authenticator overview](docs/assets/m5authenticator-overview.jpg)
    immediately after the language selector.
  • README.ja.md inserts exactly:
    ![M5Authenticatorの概要](docs/assets/m5authenticator-overview.jpg)
    at the same structural location.
  • Both READMEs reference the same single committed repository-relative image file.
  • No remote host, Issue attachment URL, CDN, data URI, clickable wrapper, hard-coded width, extra heading, or caption is introduced.
  • In both languages the image is the first content after the language switcher, with ordinary blank-line Markdown separation.
  • The README patches contain no other copy/content changes.

Scope/security boundary:

  • Effective diff is exactly:
    • README.md;
    • README.ja.md;
    • docs/assets/m5authenticator-overview.jpg.
  • SECURITY.md, AGENTS.md, Web/runtime code, firmware, release workflows, and repository About metadata are unchanged.
  • No Product, Protocol, Vault, TOTP, credential, Recovery, Device, or release behavior changes.
  • Exact binary identity plus the approved Human-source record establishes that the visible example is the intended synthetic/non-secret asset rather than a regenerated substitute.

Exact-head CI:

  • Security #940: SUCCESS.
    • repository scanner and existing release/security contracts passed with the JPEG tracked.
  • Foundation #937: SUCCESS.
    • Web and Windows Chrome jobs passed;
    • firmware regression/security contracts passed;
    • isolated ESP-IDF build/package validation and dependency-lock verification passed.

Staleness/collision:

  • Handoff HEAD matches current PR HEAD.
  • PR is open, non-draft, and mergeable.
  • Current main remains exact PR base d575e70fd7e07e9f2774762b5636cb74e94ed42d.
  • Compare is 1 commit ahead / 0 behind.
  • PR #212 is the only open PR at final Review check.
  • No ownership/collision issue exists.

Outstanding mandatory gate:

  • #211 explicitly requires an exact-head Human Gate after independent Review and before merge.
  • Integration must stop before merge and obtain Human confirmation on this exact head 6de536c9be8c2327473295f4357dd9d98c9c0a69.
  • Human must verify GitHub-rendered README.md and README.ja.md:
    1. image appears immediately below the language selector in both;
    2. both show the same intended approved image;
    3. repository-relative rendering is not broken;
    4. presentation is visually acceptable at normal GitHub README width;
    5. surrounding README structure/content remains correct.
  • Any PR-head change after that Human Gate makes the gate stale and requires re-validation.

No additional Security-role review is required for this documentation/binary presentation change.

Copy link
Copy Markdown
Owner Author

HANDOFF
FROM: review
TO: integration
ISSUE: #211
PR: #212
HEAD: 6de536c
STATE: HUMAN_GATE_REQUIRED

Copy link
Copy Markdown
Owner Author

READY_TO_MERGE

HEAD: 6de536c9be8c2327473295f4357dd9d98c9c0a69
Current main: d575e70fd7e07e9f2774762b5636cb74e94ed42d

Integration reconstruction:

  • exact PR head matches Review handoff and Human Gate
  • Review completed with no blocking finding
  • exact-head Human Gate: PASS
  • Security #940: SUCCESS
  • Foundation #937: SUCCESS
  • no unresolved review threads
  • PR base equals current main
  • no open PR collision

STATE: READY_TO_MERGE

@miso-develop
miso-develop merged commit bc5c3b9 into main Sep 18, 2026
4 checks passed
@miso-develop
miso-develop deleted the task/211 branch September 18, 2026 17:47

Copy link
Copy Markdown
Owner Author

INTEGRATED

PR: #212
Pre-merge HEAD: 6de536c9be8c2327473295f4357dd9d98c9c0a69
Squash merge commit / current main: bc5c3b90f57952f04a80c8ddfcb55b6d384c882e

Integration evidence:

STATE: INTEGRATED

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.

[Chore][Repository] Add overview hero image below README language switcher

1 participant