docs: host README images on the CDN and document StepPage publishing - #129
Merged
Merged
Conversation
The two README images were tracked in-repo under images-and-attachments/. Serve them from static-openapi.stepfun.com instead and drop the local copies, so cloning the repo no longer pulls a 128 KB screenshot and the demo can be updated without a commit. Replace the second image with a GIF showing StepPage publishing, and add a paragraph above it describing the feature: a local page is published as a reachable static site with one command, keeping development, debugging and delivery in the same terminal. Both the English and Simplified Chinese README carry the same copy.
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.
What changed
1. README images move to the CDN. Both images were tracked in-repo under
images-and-attachments/. They are now served fromstatic-openapi.stepfun.comand the local copies are deleted, so a clone no longer pulls a 128 KB screenshot and the demo can be swapped without a commit.2. The second image is now a StepPage demo GIF, with a new paragraph above it describing the feature — a local page is published as a reachable static site with one command, keeping development, debugging and delivery in the same terminal. English and Simplified Chinese carry the same copy.
3. Markdown tables were reformatted with padded columns (three tables per README). Rendering is unchanged; this is whitespace only.
Verification
Both URLs return 200 with the right content type, and
test.jpgmatches the deleted local file byte-for-byte:resource/test.jpgimage/jpegresource/demo1-small.gifimage/gifnpm run checkpasses (run by the pre-commit hook).