Skip to content

Commit a690607

Browse files
docs: point README at unversioned screenshots
Image links pinned to specific version suffixes (-v0.14, -v0.15) went stale and broke after the v0.17 capture cycle. Add unversioned copies of the three README screenshots and update /release step 4.6 to refresh them whenever screenshots are re-captured, so the README never needs editing for routine release bumps.
1 parent e5c50f1 commit a690607

5 files changed

Lines changed: 5 additions & 3 deletions

File tree

.claude/commands/release.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ Once the user confirms the version and changelog entries:
6060

6161
5. **`docs-site/docs/.vitepress/constants.ts`** — Update the `VERSION` constant. This is the single source of truth for the `{{VERSION}}` token substituted across every docs page at build time (see `docs-site/CLAUDE.md` → "Version-bump checklist"). Forgetting this leaves `docs.betweenrows.dev` showing the previous version in install/upgrade instructions.
6262

63+
6. **`docs-site/docs/public/screenshots/{introduction-dashboard,row-filters-policy-editor,row-filters-audit}.png`** — Refresh the unversioned README screenshots from their newly-captured versioned counterparts whenever screenshots were re-captured this cycle (`cp <name>-vX.Y.png <name>.png` for each of the three). The README references the unversioned files so its image links never go stale across releases — skip this only when no screenshots were re-captured.
64+
6365
### 5. Commit and tag
6466

6567
- Stage the five files above plus `Cargo.lock` (updated when Cargo.toml versions change) **and any docs-site edits applied in step 2**.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Built in **Rust** on **DataFusion** — low overhead, memory-safe, production-gr
3333

3434
| | |
3535
|---|---|
36-
| ![Admin dashboard](docs-site/docs/public/screenshots/introduction-dashboard-v0.14.png) | The admin dashboard — data sources, users, roles, and policies at a glance. |
37-
| ![Row filter policy editor](docs-site/docs/public/screenshots/row-filters-policy-editor-v0.15.png) | Row filter policy editor — write a `WHERE` expression with template variables like `{user.tenant}`. |
38-
| ![Query audit detail](docs-site/docs/public/screenshots/row-filters-audit-v0.15.png) | Query audit — see the original SQL, the rewritten SQL, and which policies fired. |
36+
| ![Admin dashboard](docs-site/docs/public/screenshots/introduction-dashboard.png) | The admin dashboard — data sources, users, roles, and policies at a glance. |
37+
| ![Row filter policy editor](docs-site/docs/public/screenshots/row-filters-policy-editor.png) | Row filter policy editor — write a `WHERE` expression with template variables like `{user.tenant}`. |
38+
| ![Query audit detail](docs-site/docs/public/screenshots/row-filters-audit.png) | Query audit — see the original SQL, the rewritten SQL, and which policies fired. |
3939

4040
## 🏗️ Components
4141

49.6 KB
Loading
82.7 KB
Loading
99.7 KB
Loading

0 commit comments

Comments
 (0)