docs(readme): tighten the layouts captions and intro - #17
Merged
Merged
Conversation
…tles The README's layouts table explained Nightjar again in its first caption, which the intro and the banner caption already do. The shots' titles (Hero: spotlight, Frame: browser, ...) now serve as the captions, and the README carries the regenerated table.
…ment The layouts intro opened with a sentence fragment, and the quick start still said showcase readme prints a table, though it has five layouts since 0.3.0.
Shironex
added
documentation
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.
Small copy fixes to the README after #16.
site/gallery/readme.config.mjsdrops itscaptionfields, the shot titles serve as captions (Hero: spotlight,Hero: row,Hero: mosaic,Frame: browser), and the README carries the tableshowcase readmeprinted. The site test that keeps the README table verbatim failed before the README update and passes after it.showcase readmeprinted the table itself."npx showcase readme # print the README tablenow says# print the README snippet (--layout for the others).bun run docs:galleryregenerated onlysite/gallery/readme/kit-readme.html: every image is byte for byte the same (budget 1791.0 KB of 4096).bun run --cwd site test(174 pass) andbun run docs:buildpass.The images that showed as broken right after #16 merged were the Pages deploy still running; they load now.