Skip to content

Commit 30eeadb

Browse files
egeominotticlaude
andcommitted
docs: promote bunqueue-dashboard package (npm, live demo, user guide)
Replace 'Coming Soon / early access' blurbs on docs home and README with the published bunqueue-dashboard package: bunx install command, live demo, user guide, GitHub and npm links; add hero action, bento card and feature grid item on the docs home. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 2eb176c commit 30eeadb

2 files changed

Lines changed: 36 additions & 5 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -626,13 +626,22 @@ await engine.signal(run.id, 'manager-approval', { approved: true });
626626

627627
<p align="center">
628628
<strong>bunqueue Dashboard</strong><br/>
629-
<sub>A visual interface for managing queues, jobs, workers and monitoring in real time. Currently in beta.</sub>
629+
<sub>A web dashboard that fully drives your bunqueue server &mdash; queues, jobs, DLQ, cron, webhooks, workers, live activity, SQLite inspector, and an AI Copilot. Open source, currently in beta. Requires Bun.</sub>
630630
</p>
631631

632632
https://github.com/user-attachments/assets/e8a8d38e-b4a6-4dc8-8360-876c0f24d116
633633

634+
```bash
635+
bunx bunqueue-dashboard
636+
```
637+
634638
<p align="center">
635-
<sub>Want early access? Reach out at <b>egeominotti@gmail.com</b></sub>
639+
<sub>
640+
<a href="https://egeominotti.github.io/bunqueue-dashboard/">Live demo</a> &middot;
641+
<a href="https://egeominotti.github.io/bunqueue-dashboard/docs/user-guide">User guide</a> &middot;
642+
<a href="https://github.com/egeominotti/bunqueue-dashboard">GitHub</a> &middot;
643+
<a href="https://www.npmjs.com/package/bunqueue-dashboard">npm: bunqueue-dashboard</a>
644+
</sub>
636645
</p>
637646

638647
---

docs/src/content/docs/index.mdx

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,32 @@ hero:
2424
link: https://www.npmjs.com/package/bunqueue
2525
icon: external
2626
variant: minimal
27+
- text: Dashboard
28+
link: https://egeominotti.github.io/bunqueue-dashboard/
29+
icon: rocket
30+
variant: minimal
2731
---
2832

2933
<div class="hp-section-header" style="margin-top: 2rem;">
30-
<span class="hp-badge">Coming Soon</span>
34+
<span class="hp-badge">Beta &middot; Open Source</span>
3135
<h2 class="hp-heading">bunqueue Dashboard</h2>
32-
<p class="hp-subtitle">A visual interface for managing queues, jobs, workers, and monitoring in real time.</p>
36+
<p class="hp-subtitle">A web dashboard that fully drives your bunqueue server &mdash; queues, jobs, DLQ, cron, webhooks, workers, live activity, SQLite inspector, and an AI Copilot.</p>
3337
</div>
3438

3539
<div class="hp-bento-card hp-bento-wide" style="max-width: 800px; margin: 0 auto 1.5rem; padding: 0; overflow: hidden;">
3640
<video src="https://github.com/user-attachments/assets/e8a8d38e-b4a6-4dc8-8360-876c0f24d116" width="100%" controls autoplay loop muted playsinline style="display: block; margin: 0;"></video>
3741
</div>
3842

39-
<p style="text-align: center; font-size: 0.95rem; color: var(--sl-color-gray-3); margin-bottom: 3rem;">Want early access? Reach out at <strong style="color: var(--sl-color-text);">egeominotti@gmail.com</strong></p>
43+
<div class="hp-install-wrap">
44+
<div class="hp-install">
45+
<span class="hp-install-dollar">$</span>
46+
<span>bunx bunqueue-dashboard</span>
47+
</div>
48+
</div>
49+
50+
<p style="text-align: center; font-size: 0.95rem; color: var(--sl-color-gray-3); margin-bottom: 3rem;">
51+
<a href="https://egeominotti.github.io/bunqueue-dashboard/">Live demo</a> &middot; <a href="https://egeominotti.github.io/bunqueue-dashboard/docs/user-guide">User guide</a> &middot; <a href="https://github.com/egeominotti/bunqueue-dashboard">GitHub</a> &middot; <a href="https://www.npmjs.com/package/bunqueue-dashboard">npm</a> &middot; Requires Bun
52+
</p>
4053

4154
<div class="hp-install-wrap">
4255
<div class="hp-install">
@@ -132,6 +145,10 @@ worker.on('failed', (job, error) => {
132145
<h3>Simple Mode</h3>
133146
<p>Queue + Worker in one object. Routes, middleware, cron, circuit breaker, batch processing, deduplication &mdash; zero boilerplate.</p>
134147
</div>
148+
<div class="hp-bento-card hp-bento-wide">
149+
<h3>Web Dashboard</h3>
150+
<p>Monitor and control everything from the browser: queues, jobs, DLQ, cron, webhooks, workers, live activity, SQLite inspector, and an AI Copilot. One command &mdash; <code>bunx bunqueue-dashboard</code> &mdash; or <a href="https://egeominotti.github.io/bunqueue-dashboard/">try the live demo</a>.</p>
151+
</div>
135152
<div class="hp-bento-card hp-bento-wide">
136153
<h3>Workflow Engine</h3>
137154
<p>Orchestrate multi-step processes with a fluent TypeScript DSL. Saga compensation, conditional branching, parallel steps, retry with backoff, nested sub-workflows, signal timeouts, loops (doUntil/doWhile), forEach iteration, map transforms, schema validation (Zod-compatible), per-execution subscribe, and typed observability events. No Temporal, no Inngest, no cloud service &mdash; just <code>bunqueue/workflow</code>.</p>
@@ -255,6 +272,11 @@ worker.on('failed', (job, error) => {
255272
<strong>Auth &amp; SSRF Protection</strong>
256273
<span>Token auth, webhook URL validation</span>
257274
</div>
275+
<div class="hp-feature-item">
276+
<svg class="hp-feature-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5"><rect x="2" y="3" width="20" height="14" rx="2"/><path d="M8 21h8"/><path d="M12 17v4"/><path d="M6 9l3 3 5-5"/></svg>
277+
<strong>Web Dashboard</strong>
278+
<span><code>bunx bunqueue-dashboard</code></span>
279+
</div>
258280
</div>
259281

260282
<div class="hp-cta">

0 commit comments

Comments
 (0)