docs(readme): add hero screenshot and refresh requirements#42
Merged
Conversation
rodindev
force-pushed
the
docs/prose-pass
branch
from
June 30, 2026 10:17
1de00dc to
27b697d
Compare
rodindev
force-pushed
the
docs/readme-screenshot
branch
from
June 30, 2026 10:17
0301ff2 to
a3d8d86
Compare
rodindev
force-pushed
the
docs/prose-pass
branch
from
June 30, 2026 10:22
27b697d to
841d309
Compare
rodindev
force-pushed
the
docs/readme-screenshot
branch
from
June 30, 2026 10:28
a3d8d86 to
710b58c
Compare
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
A hero screenshot in the README (light and dark via
prefers-color-scheme), a live-demo link under it, and refreshed requirements (Node >= 20, Vue >= 3.5).Why
The README described the inline composition without showing it. The screenshot frames the mock API page: operations sidebar, the
GET /albumscard with its parameters table and linkedReturns Albumtype, and the Try-It panel. Shot from a build that includes the parser fixes, so it shows what the next release actually renders.Note:
check:factsfails on the Vue line until the peer bump in the changelog-and-render PR reaches main; this PR merges last in the queue, after that bump.How to test
npm run format:checkpasses