Skip to content
Merged
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
17 changes: 9 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@
<div class="badge mono">NO API KEY · NO SIGNUP · FREE &amp; OPEN SOURCE</div>
<h1 class="mono">Point it at a merged PR.<br>Get a plain-English explanation.</h1>
<p class="sub">Calibrated to whoever's reading — technical or not — plus a short quiz to check it stuck.</p>
<div class="install-line mono"><span class="prompt">$</span> npm install -g pr-explainer</div>
<div class="install-line mono"><span class="prompt">$</span> npm install -g @shilpi1958/pr-explainer</div>
<div class="cta-row">
<a class="btn-primary mono" href="https://github.com/shilpi1958/pr-explainer">View on GitHub</a>
<a class="btn-secondary mono" href="https://github.com/shilpi1958/pr-explainer#readme">Read the docs</a>
Expand All @@ -327,7 +327,7 @@ <h2 class="eyebrow mono">HOW IT WORKS</h2>
<div class="steps">
<div class="step mono">
<div class="num">01</div>
<div class="desc">Write a short <code>learning-profile.md</code> your role, what you're trying to understand.</div>
<div class="desc">Run <code>pr-explainer init</code> once — edit <code>~/.pr-explainer/learning-profile.md</code> with your role and what you're trying to understand.</div>
</div>
<div class="step mono">
<div class="num">02</div>
Expand All @@ -348,9 +348,9 @@ <h2 class="eyebrow mono">HOW IT WORKS</h2>
<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 learning-profile.md</div>
<div class="ok">✓ Loaded ~/.pr-explainer/learning-profile.md</div>
<div class="ok">✓ Asking Claude to explain...</div>
<div class="out">→ saved to ./explainers/482-retry-logic-for-webhook.md</div>
<div class="out">→ saved to ~/.pr-explainer/explainers/01-retry-logic-for-webhook.md</div>
<div class="gap"></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>
Expand Down Expand Up @@ -388,18 +388,19 @@ <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">Most AI PR-summarizers make you bring your own API key and pay per call. pr-explainer shells out to the Claude Code CLI already on your machine — if you already use it, this is free to try immediately. Nothing new to sign up 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 API key, no signup, nothing new to pay for.</p>
</div>
</section>

<section class="block" id="install">
<h2 class="eyebrow mono" style="margin-bottom:32px">INSTALL</h2>
<div class="install-block mono">
<div><span class="comment"># install</span></div>
<div>$ npm install -g pr-explainer</div>
<div>$ npm install -g @shilpi1958/pr-explainer</div>
<div class="gap"></div>
<div><span class="comment"># set up your profile</span></div>
<div>$ cp learning-profile.example.md learning-profile.md</div>
<div><span class="comment"># set up your profile once (applies everywhere)</span></div>
<div>$ pr-explainer init</div>
<div>$ # edit ~/.pr-explainer/learning-profile.md</div>
<div class="gap"></div>
<div><span class="comment"># explain a PR</span></div>
<div>$ pr-explainer owner/repo#123</div>
Expand Down
Loading