Skip to content

docs: link broker sites directly from the nav, add RabbitMQ#133

Merged
powersemmi merged 1 commit into
mainfrom
docs/broker-nav-lapin
Jul 4, 2026
Merged

docs: link broker sites directly from the nav, add RabbitMQ#133
powersemmi merged 1 commit into
mainfrom
docs/broker-nav-lapin

Conversation

@powersemmi

Copy link
Copy Markdown
Owner

Description

The Brokers menu pointed each external broker (NATS, Redis) at an in-repo stub page whose
only content was a link to that broker's own documentation site, so reaching the docs took two
clicks. This makes the nav entries link straight to each broker's site and adds the RabbitMQ
broker (ruststream-lapin):

  • Nav Brokers entries for NATS, Redis, and RabbitMQ are direct external links; the redundant
    brokers/nats.md and brokers/redis.md stub pages are removed.
  • The brokers overview table gains a Docs column and a RabbitMQ row.
  • The broker-switch comparison gains a RabbitMQ tab (LapinBroker::new(..)), one line from the
    others.

Memory stays an in-repo page (it is the in-core broker). Docs-only; the strict site build and the
fence lint pass.

Type of change

  • Documentation (typos, code examples, or any documentation updates)

Checklist

  • My code follows the project's style guidelines (just check passes: rustfmt, clippy, and
    cargo check with all features and with --no-default-features)
  • I have performed a self-review of my own code
  • I have made the necessary changes to the documentation (rustdoc and/or the docs site)
  • My changes generate no new warnings (clippy runs with -D warnings)
  • I have added tests that validate my fix or new feature
  • New and existing tests pass locally (just test)

The Brokers menu pointed each external broker at an in-repo stub page whose
only content was a link to that broker's own documentation site - an extra
hop. The nav now links straight to each site (NATS, Redis, and the new
RabbitMQ / ruststream-lapin), and the stub pages are removed. The brokers
overview table gains a docs column and a RabbitMQ row, and the broker-switch
comparison gains a RabbitMQ tab.
@powersemmi powersemmi self-assigned this Jul 4, 2026
@powersemmi powersemmi added the documentation Improvements or additions to documentation label Jul 4, 2026
@powersemmi powersemmi merged commit 4d983d3 into main Jul 4, 2026
12 checks passed
@powersemmi powersemmi deleted the docs/broker-nav-lapin branch July 4, 2026 00:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant