Skip to content

docs: replace Bull Board guide with Durabull#59

Merged
aidanhibbard merged 1 commit into
aidanhibbard:mainfrom
luskin:docs/replace-bull-board-with-durabull
Jun 6, 2026
Merged

docs: replace Bull Board guide with Durabull#59
aidanhibbard merged 1 commit into
aidanhibbard:mainfrom
luskin:docs/replace-bull-board-with-durabull

Conversation

@luskin

@luskin luskin commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Replace the Bull Board playground/docs example with Durabull setup guidance for Nuxt Processor users.

Changes

  • Add a dedicated Durabull guide covering local Docker, containerized Redis, desktop app, and production self-hosting paths.
  • Update README, getting started docs, homepage action, and VitePress sidebar from Bull Board to Durabull.
  • Remove the playground Bull Board H3 handler/routes and drop unused @bull-board/* dependencies from the playground lockfile.

How to Test

  1. npm run lint
  2. npm run vp:build

Notes: this checkout is on Node v22.10.0, while the repo requests Node v24.14.0 in .nvmrc. npm did not install several optional native bindings automatically, so I installed the missing Darwin ARM64 bindings locally with --no-save to verify the docs build. npm run test still could not complete because npm run dev:prepare is blocked by further optional native binding install issues under this local Node/npm setup.

Screenshots (optional)

Not applicable; documentation/dependency cleanup only.

Linked Issues

None.

Checklist

  • I read CONTRIBUTING.md and agree to the Code of Conduct
  • I tested these changes locally
  • Added/updated tests if needed
  • Updated docs (README/docs) if needed
  • npm run ci passes (or npm run lint and npm test at minimum)
  • No breaking changes, or I documented them above

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Jun 4, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR replaces Bull Board documentation and references with Durabull throughout the codebase. Documentation navigation links are updated, a new comprehensive Durabull setup guide is added, and Bull Board dependencies are removed from the playground environment.

Changes

Bull Board to Durabull Migration

Layer / File(s) Summary
Documentation navigation and links
README.md, docs/.vitepress/config.ts, docs/index.md, docs/getting-started.md
Table of contents entry, sidebar configuration, homepage hero action, and guide section headers are switched from "Bull Board" to "Durabull" with updated link destinations.
Durabull documentation and migration notes
README.md, docs/durabull.md, changelog.md, docs/upgrading.md
New Durabull documentation page describes local Docker quick start, containerized Redis setup, desktop app installation, and production self-hosting options. Bull Board playground reference removed from README. Changelog and upgrading guide updated to reflect the change.
Playground Bull Board dependency removal
playground/package.json
The @bull-board/api, @bull-board/h3, and @bull-board/ui packages are removed from playground dependencies.

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

dependencies

🐰 From Bull to Durabull, a dashboard dance,

Where Redis queues get a second glance,

New docs in place, the navigation's swapped,

Dependencies shed—this migration's wrapped! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: replacing Bull Board documentation with Durabull guidance throughout the repository.
Description check ✅ Passed The description covers all required sections: summary, changes, how to test, linked issues, and checklist. All major changes are documented with context about testing challenges.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/durabull.md`:
- Line 65: Replace the heading text "[Self Hosting Setup]" with the hyphenated
form "[Self-hosting Setup]" in docs/durabull.md; update the link label (the
visible text between the brackets) to "Self-hosting Setup" while keeping the URL
unchanged to preserve the link target.

In `@README.md`:
- Around line 207-219: The README's docker run example binds host port 3000
which commonly conflicts with Nuxt dev servers; update the port mapping to a
non-conflicting host port (e.g., change 127.0.0.1:3000:3000 to
127.0.0.1:3001:3000) and keep APP_BASE_URL and VITE_PUBLIC_APP_URL in the
example aligned (set both to http://localhost:3001) so the container's internal
port 3000 is reachable on a different host port without colliding with a local
Nuxt app.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cd3ac2c2-fb4d-4e57-9d9e-3f808ffae0ec

📥 Commits

Reviewing files that changed from the base of the PR and between d32d519 and fe6412b.

⛔ Files ignored due to path filters (1)
  • playground/package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (12)
  • README.md
  • changelog.md
  • docs/.vitepress/config.ts
  • docs/bull-board.md
  • docs/durabull.md
  • docs/getting-started.md
  • docs/index.md
  • docs/upgrading.md
  • playground/package.json
  • playground/server/handlers/bull-board.ts
  • playground/server/routes/bull-board.ts
  • playground/server/routes/bull-board/[...].ts
💤 Files with no reviewable changes (5)
  • docs/bull-board.md
  • playground/server/routes/bull-board/[...].ts
  • playground/server/handlers/bull-board.ts
  • playground/server/routes/bull-board.ts
  • playground/package.json

Comment thread docs/durabull.md
Comment thread README.md
@aidanhibbard

Copy link
Copy Markdown
Owner

@luskin Thanks for the PR, this is great! I will get this into main, but might clean up some of the changes code rabbit asked for before I release the change for #60.

@aidanhibbard aidanhibbard merged commit 2b095be into aidanhibbard:main Jun 6, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants