Skip to content

Commit e951749

Browse files
authored
feat(guides): rework Get Started against the web console — the TUI is gone from v0.12.2 (#123) (#126)
* feat(guides): rework Get Started against the web console — the TUI is gone from v0.12.2 (#123) The trigger fired: keel v0.12.2 ships no curses TUI (keel#541 closed; keel/commands/console.py deleted) — the local web console (keel serve, keel/web/) replaced it. The four Get Started guides still taught TUI menus with TUI screenshots. Re-shot and rewritten against the real thing, run and captured on this machine: - scripts/render-webui-shots.mjs — the browser counterpart of the old render-tui-shots pipeline: scaffolds a fresh paper deployment in /tmp/keel-paper (keel init-config + keel rules seed), launches keel serve, exchanges the one-time token, and photographs six views with the system Chrome at a desktop viewport. Re-runnable per release. - Six new shots (webui-*.png) replace the eight tui-*.png; guides now teach the seven-view console (Setup checklist, Status dashboard, Insights gate distance, Rules lifecycle ledger, Gates capability table) instead of nine TUI menus. - Guide 2's credential step moves from .env to the v0.12.2 reality: keel credentials set into the OS keychain, or the Setup page's Save a market-data credential form. - Guide 4 walks the Setup checklist's To go live stage + Gates view; the asset-attestation step now records from the page (verified live: the web form attested BTC), while rail 14/17 attestations stay CLI — the checklist itself prints those commands. - Guide 1's scaffold step uses init-config + rules seed: keel init's seed step resolves the database through the state-root rules, which cannot see a folder that has no config.yaml yet (verified with a controlled KEEL_HOME test — the DB lands outside the new folder). - Stale TUI wording: install.ts guides blurb (EN+FR) now says web console; GuidePage comment and docs/SOCIAL.md updated; dead render-tui-shots.mjs removed with the tui-*.png. Closes #123 * fix(shots): mkdtemp for the scratch deployment — no fixed paths in /tmp (S5443) A predictable name in a world-writable directory is a symlink-attack surface even for a local capture script; mkdtemp closes it. The Setup screenshot keeps the path of the run that produced it — illustrative, not contractual. * fix(shots): actually import mkdtempSync from node:fs — the previous commit passed syntax but not runtime
1 parent 761ed44 commit e951749

20 files changed

Lines changed: 237 additions & 207 deletions

docs/SOCIAL.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Record every account's credential recovery in the owner's password manager
2929
|---|---|---|---|
3030
| 1 | **X/Twitter** | Dev + fintech crowd (EN); baseline discovery; where OSS lives publicly | 2–4 posts/wk |
3131
| 1 | **Telegram channel** | The Arabic crypto/Islamic-finance audience's water cooler; broadcast-only mirrors announcements | auto (RSS → channel) |
32-
| 2 | **YouTube** | The Arabic SERP research showed YouTube scholars dominate this topic — the core AR audience consumes video; TUI walkthroughs and methodology explainers fit | 1–2 videos/mo |
32+
| 2 | **YouTube** | The Arabic SERP research showed YouTube scholars dominate this topic — the core AR audience consumes video; web-console walkthroughs and methodology explainers fit | 1–2 videos/mo |
3333
| 3 | Instagram / TikTok | Mass AR/FR audience; 60-second "what is qabd" style explainers | weekly, repurposed |
3434
| 3 | LinkedIn | Islamic-finance professionals, if enterprise ever matters | monthly |
3535

@@ -47,7 +47,7 @@ Record every account's credential recovery in the owner's password manager
4747
5. Never answer "is X halal?" — the fatwa boundary is the product's edge.
4848
Redirect to the compliance methodology and fiqh-basis.
4949
6. Venue names nominatively only; never imply endorsement.
50-
7. Screenshots of the TUI (public/get-started/) and numbers from the
50+
7. Screenshots of the web console (public/get-started/) and numbers from the
5151
experiment record are the visual language. No stock chart imagery, no
5252
rockets, no lambos — a keel, a terminal, a table of honest numbers.
5353

@@ -63,11 +63,11 @@ The project already produces content weekly — social mostly re-shapes it:
6363
- Release notes → version post with the install card
6464
- Glossary terms → definition-of-the-week (EN + AR) — definition-shaped
6565
content is what AI engines and fatwa-fatigued readers both want
66-
- Get Started screenshots → TUI walkthrough threads
66+
- Get Started screenshots → web-console walkthrough threads
6767

6868
**Created (phase-gated):**
69-
- YouTube: "Run keel in five minutes" (screen recording of the actual TUI),
70-
"What attestation means", AR-language methodology explainers
69+
- YouTube: "Run keel in five minutes" (screen recording of the actual web
70+
console), "What attestation means", AR-language methodology explainers
7171
- Instagram/TikTok: 60-second explainers from the glossary, AR-first
7272

7373
## 5. Wiring into the site (after accounts exist)
-305 KB
Binary file not shown.

public/get-started/tui-data.png

-202 KB
Binary file not shown.

public/get-started/tui-help.png

-151 KB
Binary file not shown.
-151 KB
Binary file not shown.
-214 KB
Binary file not shown.

public/get-started/tui-main.png

-218 KB
Binary file not shown.

public/get-started/tui-menu.png

-213 KB
Binary file not shown.

public/get-started/tui-rules.png

-245 KB
Binary file not shown.

public/get-started/webui-fetch.png

274 KB
Loading

0 commit comments

Comments
 (0)