Skip to content

Commit 74c251f

Browse files
coolapsoCopilot
andcommitted
chore: update website with caching info and fix stale config path
- Dry-run card: mention summaries are cached, pay the AI only once - New 'Thrifty by design' card: explains the --dry-run β†’ post cache workflow with a joke about token budgets - New 'WIP? No problem.' card: documents --include-prs - Fix config path in Get Started step: ~/.autobs.json β†’ ~/.config/autobs/config.json docs: add Website section to copilot-instructions Documents build/index.html location, tone guidelines, when to update, feature card conventions, and config path source of truth. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent a7e21f2 commit 74c251f

2 files changed

Lines changed: 25 additions & 2 deletions

File tree

β€Ž.github/copilot-instructions.mdβ€Ž

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,20 @@ All terminal output lives in `cmd/root.go`. Colors use `github.com/fatih/color`
137137
└─ (not posted) ← cBox + cMeta
138138
```
139139

140+
---
141+
142+
## Website (`build/index.html`)
143+
144+
The project website is a single self-contained HTML file served at `https://autobs.coolapso.sh`.
140145

146+
* **Tone:** casual, funny, "vibe coded" personality β€” keep it irreverent. Corporate jokes, sarcastic asides, and self-aware humour are on-brand.
147+
* **Update when:** a new user-facing flag is added, a major feature changes the workflow, or existing content becomes stale (e.g. config path, flag names).
148+
* **Don't update for:** internal refactors, bug fixes, or changes that don't affect how a user interacts with the tool.
149+
* **Feature cards** live in the `<!-- FEATURES -->` grid section β€” add a card for any significant new flag or capability.
150+
* **How it works** steps reflect the high-level pipeline β€” only update if the user-visible flow changes.
151+
* **Config path:** `~/.config/autobs/config.json` (respects `$XDG_CONFIG_HOME`) β€” keep in sync with `configFilePath()` in `cmd/config_file.go`.
152+
153+
---
141154

142155
* **Formatting:** All Go code must be formatted with `go fmt` before committing.
143156
* **Linting:** All `golangci-lint` checks must be addressed before committing. Run `golangci-lint run` and resolve any reported issues.

β€Žbuild/index.htmlβ€Ž

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,17 @@ <h3>One command. That's it.</h3>
360360
<div class="card">
361361
<div class="card-icon">πŸ•΅οΈ</div>
362362
<h3>Dry-run mode</h3>
363-
<p>Preview the AI-generated corporate speak before it permanently pollutes your Jira tickets.</p>
363+
<p>Preview the AI-generated corporate speak before it permanently pollutes your Jira tickets. Summaries are cached β€” so when you approve, <code>autobs</code> posts without calling the AI again. Pay once. Post once.</p>
364+
</div>
365+
<div class="card">
366+
<div class="card-icon">πŸ’Έ</div>
367+
<h3>Thrifty by design</h3>
368+
<p>Run <code>--dry-run</code> to review. Run <code>autobs</code> to post from cache. One LLM call per update, ever. Tokens don't grow on trees and neither does your AI budget.</p>
369+
</div>
370+
<div class="card">
371+
<div class="card-icon">🚧</div>
372+
<h3>WIP? No problem.</h3>
373+
<p>Add <code>--include-prs</code> to pull in commits from your open PRs too β€” drafts included. Because work-in-progress is still work, and your PM definitely wants to hear about it.</p>
364374
</div>
365375
<div class="card">
366376
<div class="card-icon">πŸ—£οΈ</div>
@@ -430,7 +440,7 @@ <h3>Install</h3>
430440
<div class="step-num">2</div>
431441
<div>
432442
<h3>Configure</h3>
433-
<p>Run <code>autobs configure</code> β€” provide your GitHub token, Jira credentials, and LLM API key. Secrets stay local in <code>~/.autobs.json</code>.</p>
443+
<p>Run <code>autobs configure</code> β€” provide your GitHub token, Jira credentials, and LLM API key. Secrets stay local in <code>~/.config/autobs/config.json</code>.</p>
434444
</div>
435445
</div>
436446
<div class="step">

0 commit comments

Comments
Β (0)