Skip to content

Commit 891da3a

Browse files
docs: add 8 screenshots and replace placeholder gallery
Generate all 8 documentation screenshots (help, review, auto-branch, lint-on-save, diagram, setup, ai-monitor, e2e-assertions) and wire them into README.md and docs/index.html. Remove reddit draft file. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent b6f9b40 commit 891da3a

11 files changed

Lines changed: 79 additions & 52 deletions

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,16 @@ Use `/help` to see all 23 commands at any time.
6565

6666
## See It In Action
6767

68-
<!-- Record with: asciinema rec demo.cast && agg demo.cast docs/demo.gif -->
69-
![Starter Kit Demo](docs/demo.gif)
70-
71-
*Clone → `/setup``/diagram all` → hooks firing on file edit → `/review` catching issues*
72-
73-
<!-- Capture /progress output as a screenshot -->
74-
![Slash Commands](docs/commands-preview.png)
75-
76-
> **Screenshots needed:** See `docs/screenshots/README.md` for the 8 screenshots and 3 animated recordings that complete this section.
68+
| | |
69+
|---|---|
70+
| ![/help command](docs/screenshots/help-command.png) | ![/review violations](docs/screenshots/review-violations.png) |
71+
| **`/help`** &mdash; All 23 commands | **`/review`** &mdash; Catching violations with severity ratings |
72+
| ![Auto-branch hook](docs/screenshots/auto-branch.png) | ![Lint-on-save hook](docs/screenshots/hooks-lint-on-save.png) |
73+
| **Auto-Branching** &mdash; Hook blocks commits to main | **Lint-on-Save** &mdash; TypeScript errors caught instantly |
74+
| ![/diagram architecture](docs/screenshots/diagram-architecture.png) | ![/setup flow](docs/screenshots/setup-flow.png) |
75+
| **`/diagram architecture`** &mdash; Generated from actual code | **`/setup`** &mdash; Interactive .env configuration |
76+
| ![AI Monitor](docs/screenshots/ai-monitor.png) | ![E2E assertions](docs/screenshots/e2e-assertions.png) |
77+
| **AI Monitor** &mdash; Free mode, no API key needed | **E2E Tests** &mdash; Good vs bad assertions |
7778

7879
## What's Included
7980

docs/index.html

Lines changed: 69 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2006,12 +2006,77 @@ <h3>RuleCatch MCP &mdash; AI Session Analytics</h3>
20062006
<p>See the <a href="https://github.com/TheDecipherist/claude-code-mastery" target="_blank" rel="noopener">Claude Code Mastery Guide</a> for the complete MCP server directory.</p>
20072007
</section>
20082008

2009-
<!-- Screenshot Gallery (placeholder) -->
2009+
<!-- Screenshot Gallery -->
20102010
<section id="screenshot-gallery">
20112011
<h2>Screenshots</h2>
2012-
<p>Visual examples of the starter kit in action. See <code>docs/screenshots/README.md</code> for capture instructions.</p>
2013-
<div class="callout" style="background: var(--bg-secondary); border-left: 4px solid var(--accent-amber); padding: 1rem 1.25rem; border-radius: 0.5rem;">
2014-
<strong>Coming soon:</strong> Screenshots of <code>/help</code> output, <code>/review</code> catching violations, auto-branching, hooks firing, <code>/diagram</code> output, <code>/setup</code> flow, AI monitor, and E2E test assertions. Contribute by following the guide in <code>docs/screenshots/README.md</code>.
2012+
<p>The starter kit in action &mdash; every screenshot is from real command output.</p>
2013+
2014+
<div class="screenshot-grid" style="display: grid; grid-template-columns: repeat(auto-fit, minmax(400px, 1fr)); gap: 1.5rem; margin-top: 1.5rem;">
2015+
2016+
<div class="screenshot-card" style="background: var(--bg-secondary); border-radius: 0.75rem; overflow: hidden; border: 1px solid var(--border);">
2017+
<img src="screenshots/help-command.png" alt="/help command output showing all 23 commands" style="width: 100%; display: block;" loading="lazy">
2018+
<div style="padding: 0.75rem 1rem;">
2019+
<strong><code>/help</code> Command Output</strong>
2020+
<p style="margin: 0.25rem 0 0; color: var(--text-secondary); font-size: 0.875rem;">All 23 commands organized by category &mdash; Setup, Code Quality, Git, API, Documentation, Monitoring</p>
2021+
</div>
2022+
</div>
2023+
2024+
<div class="screenshot-card" style="background: var(--bg-secondary); border-radius: 0.75rem; overflow: hidden; border: 1px solid var(--border);">
2025+
<img src="screenshots/review-violations.png" alt="/review catching violations with severity badges" style="width: 100%; display: block;" loading="lazy">
2026+
<div style="padding: 0.75rem 1rem;">
2027+
<strong><code>/review</code> Catching Violations</strong>
2028+
<p style="margin: 0.25rem 0 0; color: var(--text-secondary); font-size: 0.875rem;">Severity-rated findings with file:line references, fix suggestions, and CLAUDE.md rule citations</p>
2029+
</div>
2030+
</div>
2031+
2032+
<div class="screenshot-card" style="background: var(--bg-secondary); border-radius: 0.75rem; overflow: hidden; border: 1px solid var(--border);">
2033+
<img src="screenshots/auto-branch.png" alt="Auto-branch hook blocking commit on main" style="width: 100%; display: block;" loading="lazy">
2034+
<div style="padding: 0.75rem 1rem;">
2035+
<strong>Auto-Branching on Commit</strong>
2036+
<p style="margin: 0.25rem 0 0; color: var(--text-secondary); font-size: 0.875rem;">Hook blocks commits to main and suggests feature branches &mdash; zero-friction branch safety</p>
2037+
</div>
2038+
</div>
2039+
2040+
<div class="screenshot-card" style="background: var(--bg-secondary); border-radius: 0.75rem; overflow: hidden; border: 1px solid var(--border);">
2041+
<img src="screenshots/hooks-lint-on-save.png" alt="Lint-on-save hook catching TypeScript error" style="width: 100%; display: block;" loading="lazy">
2042+
<div style="padding: 0.75rem 1rem;">
2043+
<strong>Hooks Firing (lint-on-save)</strong>
2044+
<p style="margin: 0.25rem 0 0; color: var(--text-secondary); font-size: 0.875rem;">TypeScript error caught immediately after file write &mdash; PostToolUse hook in action</p>
2045+
</div>
2046+
</div>
2047+
2048+
<div class="screenshot-card" style="background: var(--bg-secondary); border-radius: 0.75rem; overflow: hidden; border: 1px solid var(--border);">
2049+
<img src="screenshots/diagram-architecture.png" alt="/diagram architecture generating ASCII box diagram" style="width: 100%; display: block;" loading="lazy">
2050+
<div style="padding: 0.75rem 1rem;">
2051+
<strong><code>/diagram architecture</code> Output</strong>
2052+
<p style="margin: 0.25rem 0 0; color: var(--text-secondary); font-size: 0.875rem;">ASCII box-drawing diagram generated from actual source files &mdash; Client, API, Handler, Adapter layers</p>
2053+
</div>
2054+
</div>
2055+
2056+
<div class="screenshot-card" style="background: var(--bg-secondary); border-radius: 0.75rem; overflow: hidden; border: 1px solid var(--border);">
2057+
<img src="screenshots/setup-flow.png" alt="/setup interactive configuration flow" style="width: 100%; display: block;" loading="lazy">
2058+
<div style="padding: 0.75rem 1rem;">
2059+
<strong><code>/setup</code> Interactive Flow</strong>
2060+
<p style="margin: 0.25rem 0 0; color: var(--text-secondary); font-size: 0.875rem;">Category-by-category .env configuration &mdash; GitHub, Database, Docker, Analytics, RuleCatch</p>
2061+
</div>
2062+
</div>
2063+
2064+
<div class="screenshot-card" style="background: var(--bg-secondary); border-radius: 0.75rem; overflow: hidden; border: 1px solid var(--border);">
2065+
<img src="screenshots/ai-monitor.png" alt="AI-Pooler free monitor showing live tool calls and cost" style="width: 100%; display: block;" loading="lazy">
2066+
<div style="padding: 0.75rem 1rem;">
2067+
<strong>AI Monitor &mdash; Free Mode</strong>
2068+
<p style="margin: 0.25rem 0 0; color: var(--text-secondary); font-size: 0.875rem;">Live view of tool calls, tokens, cost, and files accessed &mdash; <code>npx @rulecatch/ai-pooler monitor --no-api-key</code></p>
2069+
</div>
2070+
</div>
2071+
2072+
<div class="screenshot-card" style="background: var(--bg-secondary); border-radius: 0.75rem; overflow: hidden; border: 1px solid var(--border);">
2073+
<img src="screenshots/e2e-assertions.png" alt="E2E test comparison: good assertions vs bad" style="width: 100%; display: block;" loading="lazy">
2074+
<div style="padding: 0.75rem 1rem;">
2075+
<strong>E2E Test Assertions: Good vs Bad</strong>
2076+
<p style="margin: 0.25rem 0 0; color: var(--text-secondary); font-size: 0.875rem;">Side-by-side comparison &mdash; a test that passes when broken vs one with real assertions</p>
2077+
</div>
2078+
</div>
2079+
20152080
</div>
20162081
</section>
20172082

docs/reddit-update-convert-command.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/screenshots/ai-monitor.png

78 KB
Loading

docs/screenshots/auto-branch.png

53.2 KB
Loading
72 KB
Loading
86.1 KB
Loading

docs/screenshots/help-command.png

168 KB
Loading
56.4 KB
Loading
107 KB
Loading

0 commit comments

Comments
 (0)