Align the guides with the source code - #22
Merged
Conversation
The source is authoritative; every claim in the operator guides was checked against the current classes and the drift fixed: - Configuration guide: TOC entry for section 13; the full property composition (conditional acks default, mandatory layer, max.block.ms cap, idempotence validation) in §4 and Appendix A.4; fixed key source and unreadable-MDC behavior in §6; the throttle gap is fixed in code; every fallback diversion reason, fallback ownership and the no-SLF4J-logging rule in §7; the ordered stop() sequence with all budgets, the ~18 s worst case and the no-restart rule (ADR-0004) in §8; bound-state binding decision, rebind semantics and the Logback reconfiguration gap in §9; corrected events.dispatched and fallback.dropped semantics; sendQueueCapacity, mapping and idempotence checks plus the cap warning and runtime worker-death warnings in §10; the send-dispatcher row now states drain, grace and shared budget, and two new "code" rows (key length, max.block.ms cap); the A.2 flow shows the send dispatcher step. - README: required-element wording, all fallback triggers, BlockHound note reflects the send workers, fallback.dropped causes, a working non-Spring binding sample with rebind semantics, and a truthful build section (JDK 24+, quality gates via CONTRIBUTING). - Metrics overview: accepted/dropped/send.error/shutdown semantics, appender tag on the Kafka bridge, alert wording. - Example XML: parser whitespace rule, fallback triggers, why no AsyncAppender. - benchmarks/README: RecordHeadersBenchmark is historical evidence, SenderPathBenchmark doubles as the scalar-replaceability guard, all results folders named. - CONTRIBUTING: DocumentationContractTest pins the tables. - KafkaAppender.addAppender KDoc no longer promises a restart. mvn -o verify (DocumentationContractTest, ktlint) and dokka:dokka pass. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015GfdGp7eUrjJKBvcJUx3q2
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
1 participant
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.
Summary
The source is authoritative; every claim in the operator-facing guides was checked against the current classes and the drift fixed.
acksdefault, mandatory layer,max.block.mscap, idempotence validation) in §4 and A.4; fixed key source and unreadable-MDC behavior in §6; throttle gap fixed in code; every fallback diversion reason, fallback ownership and the no-SLF4J-logging rule in §7; the orderedstop()sequence with all budgets, the ~18 s worst case and the no-restart rule (ADR-0004) in §8; bound-state binding decision, rebind semantics and the Logback reconfiguration gap in §9; correctedevents.dispatched/fallback.droppedsemantics;sendQueueCapacity, mapping and idempotence checks plus cap and worker-death warnings in §10; send-dispatcher row with drain, grace and shared budget plus two new "code" rows; A.2 flow shows the send dispatcher.fallback.droppedcauses, a working non-Spring binding sample, truthful build section.send.error/shutdownsemantics,appendertag on the Kafka bridge, alert wording.DocumentationContractTestnote.Test plan
mvn -o verify(DocumentationContractTest guards the guide tables and the metrics inventory; ktlint)mvn -o dokka:dokka(failOnWarning)mkdocs build --strict) on CI🤖 Generated with Claude Code
https://claude.ai/code/session_015GfdGp7eUrjJKBvcJUx3q2