docs(examples): surface screenshots in readme, harden render resolution#291
Merged
Conversation
the examples/ fixtures gained rendered screenshots in #290 but the top-level readme never pointed at them. add a one-line nudge from the 30-second tour so a reader can see what the cli returns before installing.
render.py resolved `vouch` off PATH first, so a stale global install shadowing the venv would render every shot against the wrong build and silently overwrite the committed images. prefer the vouch next to the running interpreter (the venv's editable build); fall back to PATH only when none exists. the guard test now passes without activating the venv.
github-actions
Bot
added
docs
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
follow-ups to #290, which added the example-kb screenshots. both are small and additive.
readme link. the screenshots landed under
examples/but the top-level readme only showeddocs/demo.gif— nothing pointed a reader at them. the 30-second tour now linksexamples/and names the captured commands, so you can see what the cli returns before installing.render hardening.
docs/img/examples/render.pyresolvedvouchoff PATH before the interpreter-local script. a stale globalvouchshadowing the venv (exactly what's on my machine — an older build without thediffsubcommand) would render every shot against the wrong cli and silently overwrite the committed svgs. it now prefers thevouchnext to the running interpreter and falls back to PATH only when none exists.verification:
tests/test_example_screenshots.pypasses — and now passes even in a shell where the venv isn't activated, which it didn't before. committed svgs are unchanged; ruff clean on the edited script.base is
testbecause the screenshot infra from #290 isn't onmainyet.