docs: fix code/API contradictions, stale references, and broken links#3089
Merged
Conversation
Documentation review across all 220 guide/tutorial pages. Snippet-embedded code (750 references) verified in sync; these fixes target prose, inline (non-snippet) code, links, and stale content. Code/API contradictions (would not compile / wrong API): - nats: UseJetStream() needs a config arg on the transport expression; TenantedIdBehavior.RequireTenantId -> TenantIdRequired; ITenantSubjectMapper.MapSubjectForTenant -> MapSubject - grpc/handlers: IdempotencyStyle.GetOrPost (nonexistent) -> Eager - runtime/heartbeats: RunOasisAsync() (nonexistent) -> RunJasperFxCommands(args) - sqs/fifo-queues: dlq.Attributes -> dlq.Configuration.Attributes - from-mediatr: handler example referenced undefined _writer/request - runtime/encryption: Encrypt<T>() -> Encrypt() Wrong package / wrong behavior: - http/validation: drop nonexistent WolverineFx.Http.DataAnnotationsValidation package; middleware ships in core Wolverine.Http - marten/index: Wolverine.Persistence.Marten -> WolverineFx.Marten - oracle: advisory locks use row-level FOR UPDATE NOWAIT, not DBMS_LOCK - marten/event-sourcing: aggregate is required-by-default (matches the page's own info box and WriteAggregateAttribute.Required = true) Stale references: - cqrs-with-marten/polecat: RunOaktonCommands -> RunJasperFxCommands - durability/index: InboxStaleTime/OutboxStaleTime remain opt-in (not 6.0 defaults) - durability/managing: add db-list to help output; Oakton -> JasperFx Internal inconsistencies / copy-paste leftovers: - azureservicebus/multi-tenancy: RabbitMQ "virtual hosts"/"outgoing" leftovers - sqlserver: "saga support for PostgreSQL" -> Sql Server - dataannotations-validation: "Fluent Validation middleware" -> Data Annotations - efcore/operations: link marten -> efcore transactional-middleware - diagnostics: startup env-check is `run --check`, not a duplicate check-env - tutorials/index: ping-pong is TCP, not Rabbit MQ - durability/sagas: add omitted SagaId fallback to id-resolution list - http/integration: add [WolverinePatch] to verb list Broken links: - basics: azure-service-bus -> azureservicebus - rabbitmq/interoperability: ./transports/rabbitmq.md -> ./index.md - partitioning: #sharded-publishing -> #partitioned-publishing-to-external-transports - vertical-slice-architecture: /tutorials/from-mediatr -> /introduction/from-mediatr - durability/index: DurabilityAgent.cs moved to Wolverine.RDBMS - serverless: empty pre-generated-types link -> codegen anchor Typos: IMesageContext -> IMessageContext (x3); Starts/StartAsync -> Starts/StartsAsync; stray ~~~~ artifacts; `dotnet add` -> `dotnet add package` for Kafka/MQTT/Redis/Pulsar. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This was referenced Jun 13, 2026
Closed
Table listed v4 as Current; repo ships 6.8.0. Now 6 = Current (no EOL), 5 = P1 fixes, 4 and earlier = EoL. The v5 EOL date is left as TBD pending the confirmed 6.0 GA + 6-month window. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Member
Author
|
Update: the support-policy.md table is now fixed in this PR too (it was originally listed under "left for a human decision"). It now shows 6 = Current (no EOL), 5 = P1 fixes, 4 and earlier = EoL. The v5 End-of-Life date is left as Follow-up issues filed for the empty/stub/TODO pages: #3090, #3091, #3092, #3093, #3094, #3095, #3096, #3097, #3098. |
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This was referenced Jun 13, 2026
This was referenced Jun 15, 2026
This was referenced Jun 23, 2026
This was referenced Jun 30, 2026
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.
Full documentation review across all 220
guide/,tutorials/, andintroduction/pages, looking for inconsistencies and anything contradicted by the current code (6.8.0). The 750 snippet-embedded code references were verified in sync (0 broken), so every fix here targets prose, inline (non-snippet) code, links, and stale content.🔴 Code/API contradictions (would not compile / wrong API)
UseJetStream()requires a config arg on the transport expression;TenantedIdBehavior.RequireTenantId→TenantIdRequired;ITenantSubjectMapper.MapSubjectForTenant→MapSubjectIdempotencyStyle.GetOrPost(doesn't exist) →EagerRunOasisAsync()(doesn't exist) →RunJasperFxCommands(args)dlq.Attributes[...]→dlq.Configuration.Attributes[...]_writer/requestEncrypt<T>()→Encrypt()🔴 Wrong package / wrong described behavior
WolverineFx.Http.DataAnnotationsValidationpackage (the middleware ships in coreWolverine.Http)Wolverine.Persistence.Marten→WolverineFx.MartenFOR UPDATE NOWAIT, notDBMS_LOCK/schema-hashWriteAggregateAttribute.Required = true,Simple404) — which also matches the page's own info box🟡 Stale references
RunOaktonCommands→RunJasperFxCommandsdb-listto the help output; Oakton → JasperFx🟡 Internal inconsistencies / copy-paste leftovers
run --check, not a duplicatecheck-envSagaIdstep to the id-resolution list[WolverinePatch]to the verb list🟡 Broken links
azure-service-bus→azureservicebus./transports/rabbitmq.md→./index.md#sharded-publishing→#partitioned-publishing-to-external-transports/tutorials/from-mediatr→/introduction/from-mediatrDurabilityAgent.csGitHub link →Wolverine.RDBMSpath⚪ Typos
IMesageContext→IMessageContext(x3);Starts/StartAsync→Starts/StartsAsync; stray~~~~artifacts;dotnet add→dotnet add packagefor Kafka/MQTT/Redis/Pulsar.Deliberately left out (need a human decision, not a mechanical fix)
messaging/policies.md,sqs/queues.md,tutorials/dead-letter-queues.md(title-only); empty section headers inmessaging/introduction.md; the truncated "Spy" section inefcore/domain-events.md;TODO/snippet-todoplaceholders inmessage-bus.md,handlers/multi-tenancy.md,handlers/error-handling.md, andazureservicebus/deadletterqueues.md. These need real content.messages.md.NET 8NotSupportedExceptioncaveat, the ".NET 6/7 Program file" framing inmanaging.md, and the "Wolverine 4.0 will embrace IHealthCheck" aside indiagnostics.md.🤖 Generated with Claude Code