Skip to content

docs: fix the improvement tail (P1–P18)#80

Merged
lesnik512 merged 1 commit into
mainfrom
docs/audit-improvement-tail-p1-p18
Jun 14, 2026
Merged

docs: fix the improvement tail (P1–P18)#80
lesnik512 merged 1 commit into
mainfrom
docs/audit-improvement-tail-p1-p18

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Closes out the improvement tail (P1–P18) from the 2026-06-13 docs audit
(planning/audits/2026-06-13-docs-audit-findings.md) — convenience,
readability, and gap fixes. Signatures/defaults verified against source;
mkdocs build --strict is clean (all new internal anchors resolve).

With this merged, every finding from the audit (B1–B5, C1–C3, I1–I15,
P1–P18) is resolved.

Findings fixed

ID Page Fix
P1 subscriber.md Document propagate_inbound_headers in the options table
P2 subscriber.md Note the standard passthrough kwargs (dependencies, parser, decoder, AsyncAPI fields)
P3 subscriber.md Add a retry-strategy params/defaults table + shared caps
P4 publisher.md Show the broker.publisher(...) constructor signature
P5 publisher.md FastAPI-specific callout on the OutboxResponse chained-publish example (session must outlive the handler return)
P6 index.md Signpost the three observability entries (concept / reference / step-by-step)
P7 instrumentation-seams.md State the recorder "must not block" constraint
P8 observability.md Add a bundled-adapter wiring snippet
P9 comparison.md Bullet the "vs. writing your own" feature wall
P10 comparison.md Add an at-a-glance decision matrix
P11 comparison.md Give the CDC verdict a falsifiable detail
P12 how-it-works.md Flesh out the relay stub
P13 how-it-works.md Dedupe the idempotency note
P14 testing.md Runnable loop-mode feed() + poll example
P15 testing.md Drop the inconsistent @pytest.mark.asyncio marker
P16 troubleshooting.md Name the missing-timer_id DLQ migration cause
P17 basic.md Drop the unexplained max_workers=4
P18 relay.md Setup note + OutboxResponse import in the anti-pattern

🤖 Generated with Claude Code

Close out the convenience/readability/gap tail from the 2026-06-13 docs
audit; signatures and defaults verified against source.

- P1/P2/P3 subscriber.md: document propagate_inbound_headers, the
  standard passthrough kwargs, and a retry-strategy params/defaults table.
- P4/P5 publisher.md: show the broker.publisher() signature; add a
  FastAPI-specific callout to the OutboxResponse chained-publish example
  (the session must outlive the handler return — vanilla apps call
  broker.publish directly).
- P6 index.md: signpost the three observability entries (concept /
  reference / step-by-step).
- P7 instrumentation-seams.md: state the recorder "must not block"
  constraint; make the event count self-documenting.
- P8 observability.md: add a bundled-adapter wiring snippet.
- P9/P10/P11 comparison.md: bullet the feature wall, add a decision
  matrix, give the CDC verdict a falsifiable detail.
- P12/P13 how-it-works.md: flesh out the relay stub; dedupe the
  idempotency note.
- P14/P15 testing.md: runnable loop-mode example; drop the inconsistent
  pytest.mark.asyncio marker.
- P16 troubleshooting.md: name the missing-timer_id DLQ migration cause.
- P17 basic.md: drop the unexplained max_workers=4.
- P18 relay.md: setup note + OutboxResponse import in the anti-pattern.

All findings (B1–B5, C1–C3, I1–I15, P1–P18) now resolved.
mkdocs build --strict clean.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@lesnik512
lesnik512 merged commit e0e96fe into main Jun 14, 2026
3 checks passed
@lesnik512
lesnik512 deleted the docs/audit-improvement-tail-p1-p18 branch June 14, 2026 06:27
lesnik512 added a commit that referenced this pull request Jun 14, 2026
All 41 findings resolved (B1–B5, C1–C3, I1–I15, P1–P18); flip status to
shipped and record PRs #79 / #80.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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