Skip to content

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

Description

@miso-develop

Related

Owner

  • ACTIVE_ROLE: implementation
  • DOMAIN: infra

State

READY_FOR_REVIEW

Baseline

Specification baseline: main = d575e70fd7e07e9f2774762b5636cb74e94ed42d.

At Specification time:

  • open PRs: none;
  • README.md language switch is line 3: **English** | [日本語](README.ja.md);
  • README.ja.md language switch is line 3: [English](README.md) | **日本語**;
  • neither README currently displays a hero/overview image.

Human-provided approved image

Use the image supplied by the human owner with this request.

Approved source-asset identity:

  • source filename: top.jpg
  • format: JPEG
  • dimensions: 840 × 420
  • byte size: 122,915 bytes
  • SHA-256: 215ed9c6ffe29ec7ba302dc830569286b188bcfb3c9885f4e4b8b48be3556b42

The image is intended for public repository presentation and contains only synthetic/non-secret example content.

Implementation must use this approved image, not recreate or substitute a visually similar image.

If retrieving it from the originating chat/File Library, verify the SHA-256 above before committing. If the exact approved asset cannot be obtained in the Implementation environment, do not substitute another image; record the dependency and return for the exact asset.

Objective

Display the approved M5Authenticator overview image immediately below the language-switch row in both the English and Japanese GitHub READMEs.

Both languages must reference the same committed image file.

Asset path

Commit the approved JPEG under:

docs/assets/m5authenticator-overview.jpg

Create docs/assets/ if it does not already exist.

Do not duplicate separate EN/JA copies.

The committed image must retain:

  • 840 × 420 dimensions;
  • the approved visual content;
  • no added metadata containing private/local filesystem information.

Byte-for-byte preservation of the supplied JPEG is preferred. If tooling strips non-visual metadata, the visible pixels/content must remain unchanged and implementation must record that transformation; do not crop, redraw, regenerate, recolor, or add text.

README placement

README.md

Current beginning:

# M5Authenticator

**English** | [日本語](README.ja.md)

M5Authenticator is ...

Required result:

# M5Authenticator

**English** | [日本語](README.ja.md)

![M5Authenticator overview](docs/assets/m5authenticator-overview.jpg)

M5Authenticator is ...

README.ja.md

Current beginning:

# M5Authenticator

[English](README.md) | **日本語**

M5Authenticatorは...

Required result:

# M5Authenticator

[English](README.md) | **日本語**

![M5Authenticatorの概要](docs/assets/m5authenticator-overview.jpg)

M5Authenticatorは...

The image must therefore be the first content immediately after the language selector in both READMEs, with normal blank-line Markdown separation and no additional heading/caption block inserted above it.

Rendering requirements

  • Use a repository-relative path so the image renders on GitHub branch/default README views.
  • Prefer standard Markdown image syntax as specified above.
  • Do not use a remote image host, runtime URL, data URI, GitHub Issue attachment URL, or CDN.
  • Do not make the image clickable unless separately requested.
  • Preserve normal responsive GitHub image behavior; do not hard-code a viewport-specific width.
  • English and Japanese READMEs must remain structurally parallel.
  • Existing README copy, Web link, Security links, and documentation links remain unchanged except for the image insertion.

Security / repository constraints

  • The committed image must contain no real TOTP secret, QR payload, Device ID, Recovery Passphrase/Package, keys, production account metadata, or credential-bearing EXIF/comment data.
  • The visible example in the approved image is synthetic and may remain as supplied.
  • Run the repository security scan against the binary addition.
  • Do not modify SECURITY.md, AGENTS.md, product code, Web runtime, firmware, release workflows, or repository About metadata for this Task.

Human Gate before Integration

HUMAN_GATE_REQUIRED before any merge to main.

After Implementation and independent Review are complete, Integration must stop before merge and obtain Human confirmation on the exact PR head.

Human Gate must verify on GitHub-rendered README views, using the exact candidate head:

  • README.md shows the approved overview image immediately below the language selector;
  • README.ja.md shows the same image immediately below the language selector;
  • image content is the intended human-supplied asset, not a substituted/re-generated image;
  • image rendering is not broken and the repository-relative path resolves correctly;
  • the image is visually acceptable at normal GitHub README width;
  • surrounding README structure/content remains correct in both languages.

The exact PR head validated by Human must match the head handed to Integration. If the PR head changes after Human Gate, the Gate is stale and must be rerun.

Integration must not merge #211 until:

  1. independent Review has passed;
  2. required CI/security checks are green;
  3. the exact-head Human Gate has passed.

Acceptance

  • Exact approved overview image is committed once at docs/assets/m5authenticator-overview.jpg.
  • Image dimensions are 840 × 420 and visual content matches the human-supplied asset.
  • README.md renders that image immediately below the English/Japanese language selector.
  • README.ja.md renders the same image immediately below the language selector.
  • EN alt text is M5Authenticator overview.
  • JA alt text is M5Authenticatorの概要.
  • No extra heading/caption appears between language selector and image.
  • Both README files otherwise retain current product-facing structure/content.
  • Image uses a repository-relative path and no external image dependency.
  • Security scan / applicable documentation checks pass.
  • Diff is limited to the one approved image asset plus README.md and README.ja.md.
  • Independent Review is performed before Integration; Implementation does not merge its own PR.
  • Exact-head Human Gate passes before any merge to main.
  • Any PR-head change after Human Gate invalidates the prior Human Gate and requires re-validation.

Collision / coordination

No open PR exists at Specification time.

Implementation must re-check Issues/PRs/branches before claim, with ownership of:

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

References

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions