Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ <h1 class="mono">Point it at a merged PR.<br>Get a plain-English explanation.</h

<section class="block" id="how-it-works">
<h2 class="eyebrow mono">HOW IT WORKS</h2>
<p class="section-sub">Four steps, one command.</p>
<p class="section-sub">Init once. Then one command per PR.</p>
<div class="steps">
<div class="step mono">
<div class="num">01</div>
Expand All @@ -335,31 +335,32 @@ <h2 class="eyebrow mono">HOW IT WORKS</h2>
</div>
<div class="step mono">
<div class="num">03</div>
<div class="desc">It reads the diff + description via the GitHub CLI, combines it with your profile, and asks Claude to explain it.</div>
<div class="desc">It reads the diff + description via the GitHub CLI, combines it with your profile, and shells out to the Claude Code CLI to explain it.</div>
</div>
<div class="step mono">
<div class="num">04</div>
<div class="desc">Saved locally, added to a running index of every PR you've explained so far.</div>
<div class="desc">Saved under <code>~/.pr-explainer/explainers/</code>, added to a running index of every PR you've explained so far.</div>
</div>
</div>

<div class="terminal">
<div class="terminal-bar"><span></span><span></span><span></span></div>
<div class="terminal-body mono">
<div><span class="prompt">$</span> pr-explainer https://github.com/acme/billing-service/pull/482</div>
<div class="ok">✓ Fetched PR #482 · "Add retry logic to payment webhook handler"</div>
<div class="ok">✓ Loaded ~/.pr-explainer/learning-profile.md</div>
<div class="ok">✓ Asking Claude to explain...</div>
<div class="out">→ saved to ~/.pr-explainer/explainers/01-retry-logic-for-webhook.md</div>
<div><span class="prompt">$</span> pr-explainer https://github.com/facebook/react/pull/32</div>
<div class="ok">Generating explainer for PR #32: Add new onInput event</div>
<div class="out">~/.pr-explainer/explainers/01-react-now-responds-to-text-input-changes-faster-and-more-rel.md</div>
<div class="gap"></div>
<div class="hd"># React now responds to text input changes faster and more reliably</div>
<div class="out"><strong>Ships:</strong> A new onInput event that fires as users type or paste — replacing the older onKeyUp approach.</div>
<div class="gap-sm"></div>
<div class="hd">## What changed</div>
<div class="out">Webhook calls to the payment processor now retry 3× with backoff instead of failing silently on timeout.</div>
<div class="out">React's event system gains an input event that fires whenever a text field's content changes — typing, paste, voice, autocomplete.</div>
<div class="gap-sm"></div>
<div class="hd">## Why it matters to you</div>
<div class="out">You've been seeing "missing payment" support tickets that were actually just dropped webhooks — this should cut those out.</div>
<div class="hd">## Why it matters</div>
<div class="out">Live search, counters, and previews update immediately — and they keep working when users paste instead of typing letter-by-letter.</div>
<div class="gap-sm"></div>
<div class="hd">## Quiz</div>
<div class="out">Q: Why retries instead of a longer timeout? <span class="ans">▸ answer</span></div>
<div class="hd">## Quick check</div>
<div class="out">Q: Why onInput instead of onKeyUp? <span class="ans">▸ answer</span></div>
</div>
</div>
</section>
Expand Down Expand Up @@ -388,7 +389,7 @@ <h3>Keep track of your own project</h3>
<section class="block">
<div class="narrow">
<h2 class="eyebrow mono" style="margin-bottom:14px">WHY NO API KEY</h2>
<p class="body">pr-explainer shells out to the Claude Code CLI already on your machine — if you already use it, this is free to try immediately. No separate API key, no signup, nothing new to pay for.</p>
<p class="body">pr-explainer shells out to the Claude Code CLI already on your machine — if you already use it, this is free to try immediately. No separate Anthropic Console API key, no signup for this tool. You do need Claude Code installed and logged in, plus the GitHub CLI (<code>gh</code>).</p>
</div>
</section>

Expand All @@ -408,7 +409,7 @@ <h2 class="eyebrow mono" style="margin-bottom:32px">INSTALL</h2>
</section>

<footer class="mono">
<span class="tagline">MIT licensed · self-hosted · no data leaves your machine</span>
<span class="tagline">MIT licensed · self-hosted · uses your local Claude Code + gh auth</span>
<div class="links">
<a href="https://github.com/shilpi1958/pr-explainer">GitHub</a>
<a href="https://www.producthunt.com/">Product Hunt</a>
Expand Down