Skip to content

Commit 028ff17

Browse files
committed
docs(llms): describe the FAQ as it now is, and surface broker TLS to agents
llms.txt is what the MCP server reads for the human-written label and blurb it shows against a page, so a stale blurb is stale in every agent that searches these docs. The FAQ entry still said "twenty-one common tasks" and listed nothing about encryption, while the page carries thirty-one answers and a whole "Encrypting the broker connection" section. Counted, not estimated: 31 `###` questions. Also widens the auto-scaling broker post's summary, description and keywords to say that it now covers encrypting a discovered fleet, and adds the discovered-fleet terms to the FAQ's keywords — those fields are what both the site search index and MCP `search_docs` rank and display. No new pages, so the section list in llms.txt is unchanged; the new FAQ answers and the post's "Encrypting the fleet" section were already carried by search-index.json and search-sections.json from the previous commit, which is what deep-links an agent into them. Verified: 18 checks and 175 e2e tests pass, no regressions against the baseline.
1 parent 0d447f2 commit 028ff17

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

src/llms.liquid

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ are individually addressable. The anchor convention is stated in the description
224224
rather than in the intro block above, because it is a fact about this page and not
225225
a site-wide one — every other page is fetched whole.
226226
{%- endcomment %}
227-
- [FAQ]({{ siteUrl }}/api/faq/): Direct answers to twenty-one common tasks — exposing a method, generating a typed client, complex types and JSDoc/removeComments, argument validation, pg-cache and tagged-cache invalidation, delayed and retried jobs, single-listener Postgres notifications, GraphQL N+1, OpenTelemetry registration, logger transports, auto-scaling services on the built-in queue-length metrics endpoint, auto-scaling the Redis broker with the promoter/unicaster announcer modules, per-IP rate limiting and CIDR membership. Each answer links the generated reference for the symbols it names. Every question is a `###` heading with a stable slug, so `{{ siteUrl }}/api/faq/#<slug>` addresses one answer instead of the page. — [markdown]({{ siteUrl }}/api/faq/index.md)
227+
- [FAQ]({{ siteUrl }}/api/faq/): Direct answers to thirty-one common tasks — exposing a method, generating a typed client, complex types and JSDoc/removeComments, argument validation, pg-cache and tagged-cache invalidation, delayed and retried jobs, single-listener Postgres notifications, GraphQL N+1, OpenTelemetry registration, logger transports, auto-scaling services on the built-in queue-length metrics endpoint, auto-scaling the Redis broker with the promoter/unicaster announcer modules, draining in-flight requests on deploy, per-IP rate limiting and CIDR membership, and encrypting the broker connection with TLS — fleet-wide from the environment, with mutual TLS against a private CA, and for a discovered fleet whose brokers announce addresses no certificate can carry. Each answer links the generated reference for the symbols it names. Every question is a `###` heading with a stable slug, so `{{ siteUrl }}/api/faq/#<slug>` addresses one answer instead of the page. — [markdown]({{ siteUrl }}/api/faq/index.md)
228228
- [@imqueue/core API reference]({{ siteUrl }}/api/core/latest/): Every exported symbol of @imqueue/core, generated from {{ apiVersions.core.latest }} — this URL always serves the current major. The Redis-backed message queue: IMQ factory, RedisQueue, ClusteredRedisQueue, IMQOptions, the profile decorator and the cluster-manager extension points. — [markdown]({{ siteUrl }}/api/core/latest/index.md)
229229
- [@imqueue/rpc API reference]({{ siteUrl }}/api/rpc/latest/): Every exported symbol of @imqueue/rpc, generated from {{ apiVersions.rpc.latest }} — this URL always serves the current major. Typed RPC: IMQService, IMQClient, the expose/property/classType/lock/cache/logged decorators, the service Description shape used for client generation, and the cache and lock APIs. — [markdown]({{ siteUrl }}/api/rpc/latest/index.md)
230230
{%- comment -%}

src/org/api/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ crumbLeaf: FAQ
77
heading: Frequently Asked Questions
88
lead: "Direct answers to the questions developers are actually asking — each one linking the reference for the symbols it names."
99
description: "@imqueue FAQ: expose a method, generate a typed client, cache and invalidate, validate arguments, delay and retry jobs, trace, log, auto-scale, drain on deploy, rate-limit and encrypt the broker connection with TLS."
10-
keywords: "imqueue faq, expose service method, imqueue generate typed client, classType property decorators, removeComments false imqueue, pg-cache cacheBy, imqueue job delay retry, PgPubSub singleListener, graphql N+1 microservices, ImqueueInstrumentation, LOGGER_TRANSPORTS, imqueue send does not throw, JobQueue push error, imqueue silent failure logging, imqueue metrics server queue_length, kubernetes HPA queue length autoscaling, graceful shutdown nodejs, IMQ_DRAIN_ENABLE, drain in-flight requests, redis-broker-promoter, redis-broker-unicaster, UDPClusterManager, HttpProtect express middleware, CIDR membership Node.js, redis tls nodejs, IMQ_REDIS_TLS, encrypt broker connection, redis mutual tls, envTls, tlsFingerprint"
10+
keywords: "imqueue faq, expose service method, imqueue generate typed client, classType property decorators, removeComments false imqueue, pg-cache cacheBy, imqueue job delay retry, PgPubSub singleListener, graphql N+1 microservices, ImqueueInstrumentation, LOGGER_TRANSPORTS, imqueue send does not throw, JobQueue push error, imqueue silent failure logging, imqueue metrics server queue_length, kubernetes HPA queue length autoscaling, graceful shutdown nodejs, IMQ_DRAIN_ENABLE, drain in-flight requests, redis-broker-promoter, redis-broker-unicaster, UDPClusterManager, HttpProtect express middleware, CIDR membership Node.js, redis tls nodejs, IMQ_REDIS_TLS, encrypt broker connection, redis mutual tls, envTls, tlsFingerprint, encrypt discovered redis fleet, IMQ_REDIS_TLS_SERVERNAME, redis-broker tls-port"
1111
relatedTopics: [rpc, dx, patterns, jobs, security]
1212
faqPage: true
1313
---

src/org/blog/posts/horizontally-scalable-redis-broker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ layout: post.html
33
permalink: /blog/horizontally-scalable-redis-broker/
44
templateEngineOverride: md
55
title: "Auto-scaling Redis broker: with and without broadcast"
6-
summary: "One Redis behind your message bus is a ceiling and a single point of failure. The promoter and unicaster modules turn a fleet of plain Redis instances into a horizontally auto-scaling broker — here are the recipes for networks that deliver broadcast and for clouds like GCP that don't."
7-
description: "Run a horizontally auto-scaling Redis broker with @imqueue: client-side clustering, UDP broker discovery, and a unicast path for GCP/Kubernetes."
8-
keywords: "horizontally scalable redis broker, redis broker auto-scaling, horizontal auto-scaling redis, scale redis message queue, redis broker cluster, redis broker discovery, redis-broker-promoter, redis-broker-unicaster, imqueue cluster, udp broadcast discovery, GCP redis broker, kubernetes redis broker"
6+
summary: "One Redis behind your message bus is a ceiling and a single point of failure. The promoter and unicaster modules turn a fleet of plain Redis instances into a horizontally auto-scaling broker — here are the recipes for networks that deliver broadcast and for clouds like GCP that don't, and how to encrypt the result when the brokers announce addresses no certificate can carry."
7+
description: "Run a horizontally auto-scaling Redis broker with @imqueue: client-side clustering, UDP broker discovery, a unicast path for GCP/Kubernetes, and TLS on a fleet whose broker addresses come from the scheduler."
8+
keywords: "horizontally scalable redis broker, redis broker auto-scaling, horizontal auto-scaling redis, scale redis message queue, redis broker cluster, redis broker discovery, redis-broker-promoter, redis-broker-unicaster, imqueue cluster, udp broadcast discovery, GCP redis broker, kubernetes redis broker, redis broker tls, encrypt redis broker fleet, redis tls-port announcement, IMQ_REDIS_TLS_SERVERNAME"
99
date: 2026-07-24
1010
dateModified: 2026-09-01
1111
author: serhiy-morenko

0 commit comments

Comments
 (0)