docs: fix the improvement tail (P1–P18)#80
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 --strictis 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
propagate_inbound_headersin the options tabledependencies,parser,decoder, AsyncAPI fields)broker.publisher(...)constructor signatureOutboxResponsechained-publish example (session must outlive the handler return)feed()+ poll example@pytest.mark.asynciomarkertimer_idDLQ migration causemax_workers=4OutboxResponseimport in the anti-pattern🤖 Generated with Claude Code