Skip to content

docs: rewrite README and restore original Bunqueue branding - #86

Merged
egeominotti merged 1 commit into
mainfrom
docs/readme-original-logo
Oct 26, 2026
Merged

egeominotti merged 1 commit into
mainfrom
docs/readme-original-logo

Conversation

@egeominotti

Copy link
Copy Markdown
Owner

What & why

Rewrite the README around first-run setup, supported operations and deployment choices, using the original Bunqueue logo supplied by the user. The same unmodified upstream SVG now serves as the documentation logo and application/docs favicon.

Changes

  • Put the one-command quick start first; document external-server authentication, static Docker deployment and the standalone launch-command requirement accurately.
  • Link the full operational guides and use absolute image URLs that render on GitHub and npm.
  • Prepare version 1.0.5 and its changelog entry as required by the continuous release workflow.

Validation

  • Native Bun typechecking/formatting, Oxlint, architecture/version checks, production build and bundle budgets passed.
  • Documentation build and all four documentation browser tests passed.
  • README preview checked at 1440px and 390px: six images load, four tables render, no page overflow or browser errors.
  • Local references exist; all 31 accessible external references return HTTP 200. npmjs blocks automated HTTP requests with 403; the package identity and URL are verified separately through the registry.
  • All four SVGs exactly match the official upstream Git blob 21a7d481dded8609af7a5f167cd66a90040498af.

@egeominotti
egeominotti merged commit 6923857 into main Oct 26, 2026
23 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.

1 participant