Repository navigation
docs: publish the workflow PNG for community sharing - #414
Merged
Merged
Conversation
what changed: Add the existing workflow illustration as a byte-identical PNG and document its editable SVG source, dimensions, suggested alt text and sharing context. why: Community publishing services need a public raster image, and GitHub release downloads serve a generic MIME type. A repository image offers a stable raw image URL. what it touched: docs/assets/research-kit-workflow.png and docs/assets/README.md. The README's first SVG preview and product behavior are unchanged. what you verified: verified - PNG visually inspected at 1440 x 820, copied SHA256 matches the original bb9d0d98a4efec62d716d66cee58117f0e4ebe36b8472481d18ea7e6eb8141bf. The normal repository commit gate runs before acceptance. Expected - the published raw PNG URL serves image/png; it will be checked after push. what you got wrong and fixed: mistake - first used a release-download URL for the launch illustration; where - public announcement image; impact - image-only consumers may refuse its application/octet-stream response, while no social posts were scheduled; cause - download serving differs from the asset's recorded image/png metadata; fix - publish the same PNG in the repository and replace the announcement link after verification; verified - HTTP HEAD identified the release response and the original/copy image hashes agree. mistake - attempted staging before the copy command had completed; where - local media preparation; impact - git add failed and the empty-index commit created no commit; cause - proceeded after a dependent command yielded a running session; fix - waited for both terminal results, verified the file exists and staged only the two intended assets; verified - the staged PNG hash matches the original and staged whitespace is clean.
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.
Community publishing services need a public raster image for Research-Kit's workflow. This adds the existing 1440 × 820 illustration as a PNG, with a verified permanent URL that serves
image/png.what changed: Add the byte-identical workflow PNG and document its editable SVG source, dimensions, alt text and sharing context.
why: The launch announcement needs a reliable image URL. The GitHub release download responds with a generic MIME type; the repository PNG serves the appropriate type.
what it touched: Only docs/assets/research-kit-workflow.png and docs/assets/README.md.
what you verified: Verified visual inspection, matching SHA256 bb9d0d98a4efec62d716d66cee58117f0e4ebe36b8472481d18ea7e6eb8141bf, clean staged diff and acceptance by the normal documentation commit gate. The immutable raw URL returned HTTP 200, image/png and 206,036 bytes. GitHub CI follows before merge.
what you got wrong and fixed: The first announcement image used the release download URL; HTTP verification identified its generic MIME response. The repository PNG corrects that. An initial staging attempt ran before the copy completed; git add failed and created no commit. I waited for the terminal results, verified the copied hash and committed only the intended two files.