docs: add clear before/after previews to README (#288) - #317
Merged
Conversation
Adds a "See it in action" before/after comparison to the top of the README so the package's value is visible immediately, and replaces the confusing combined before/after image in docs/usage.md with the same clear side-by-side pair. - Before: the Block Grid editor as default labelled cards - After: blocks rendered as real HTML in the backoffice Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The README is the NuGet PackageReadmeFile so images need absolute URLs. v5/dev is the branch this PR merges into and the one GitHub renders the repo README from, so the images resolve as soon as this is merged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The confusing combined before/after image is no longer referenced after docs/usage.md was updated to the clear side-by-side pair. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
rickbutterfield
added a commit
that referenced
this pull request
Jul 8, 2026
…e-after docs: add clear before/after previews to README (#288)
rickbutterfield
added a commit
that referenced
this pull request
Jul 8, 2026
The #317 cherry-pick brought URLs pinned to v5/dev; repoint the preview-before/after images (README, usage, marketplace) at v6/dev so the v6 branch references its own assets. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.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.
Closes #288
What
Adds a clear before / after comparison so the package's value is obvious at first glance:
docs/usage.md— replaces the single combined image (screenshot2.png) that Show what the package does first thing in the readme? #288 called out as confusing with the same clear side-by-side pair.Why
Per #288, the only existing visual was a single image labelled "before and after", which mixed both states into one picture and read as confusing/wrong. New adopters couldn't quickly tell what the package does. This surfaces it immediately.
Notes
Homenode) with previews off vs on..github/assets/preview-before.pngandpreview-after.png.PackageReadmeFile, so the images use absoluteraw.githubusercontent.comURLs pointing atv5/dev(matching the convention the existing assets use, and the branch this PR merges into) — so they resolve as soon as this is merged. They'll appear broken in the PR diff until then.screenshot2.pngis now unreferenced. I left it in place rather than delete an existing asset — happy to remove it in this PR if you'd prefer.🤖 Generated with Claude Code