docs(readme): link Ratatui's snapshot-testing recipe; say what the renderers are for - #337
Merged
Conversation
…nderers are for Ratatui's recipe at ratatui.rs/recipes/testing/snapshots includes a termlens example that drives a compiled application through a PTY. Link it after the badges, in wording that claims what the page says and nothing more: a documentation reference, not an endorsement. "What it is (and is not)" said termlens is not an SVG transcript generator while the crate ships to_svg, to_html and `termlens render`. Both are true; the bullet now says why: the renderers exist so a failing screen can be looked at in a CI job summary or a pull request, which is what the report action does with them. No code changes. Closes #333 Signed-off-by: Vyncint Ng <115854244+vyncint@users.noreply.github.com>
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.
Two documentation-only changes to the README, from #333.
Ratatui recipe. Ratatui's snapshot-testing recipe includes a termlens example that drives a compiled application through a PTY. A short paragraph after the badges links it, worded to claim exactly what the page says — a documentation reference — not "recommended by" or "official".
What the renderers are for. "What it is (and is not)" said termlens is not an SVG transcript generator, while the crate ships
to_svg,to_htmlandtermlens render. Both statements are true; the bullet now explains the purpose — a failing screen as a CI artifact, which is what the report action uses them for — and links the CI section.No code changes. Rendered output checked in the diff; the in-page anchor
#at-a-shell-prompt-and-in-cimatches the existing heading.Closes #333
Signed-off-by: Vyncint Ng 115854244+vyncint@users.noreply.github.com