Review documentation gaps for product defects and missing capabilities #213

Activity

1. rmcdaniel

   closed this as completedin #214on Oct 20, 2026
2. rmcdaniel commented on Oct 20, 2026

   

   rmcdaniel

   on Oct 20, 2026

   Last edited by rmcdaniel

   MemberAuthor

   More actions

   Applied the product-review rule to the documentation backlog

   Reviewed all 24 then-open documentation-labelled issues across the Website/PHP/Python SDK repositories, plus the five recently closed guidance issues durable-workflow/durable-workflow.github.io#258, durable-workflow/durable-workflow.github.io#264, durable-workflow/durable-workflow.github.io#266, durable-workflow/durable-workflow.github.io#281, durable-workflow/durable-workflow.github.io#284. The separate closed website dependency-security issue durable-workflow/durable-workflow.github.io#261 was also checked; it already had a real dependency fix and qualified publication.

   Docs wrappers superseded by actual product work

   Former Website ticket	Product owner and remaining requirement
   durable-workflow/durable-workflow.github.io#302 workflow clock	Shared #215: advancing replay-safe clocks and compatible existing-run migration.
   durable-workflow/durable-workflow.github.io#306 payload privacy	Shared #217: opt-in client-side encryption hooks, fixed Avro wire format, key rotation and replay/inline/external qualification.
   durable-workflow/durable-workflow.github.io#272 checkpoints	Shared #218: acknowledged checkpoint retrieval on replacement attempts; reuse #211's execution identity.
   durable-workflow/durable-workflow.github.io#273 recoverable bulk operations	CLI #59: selected-run cancellation defect; CLI #60: durable inspectable resume manifests.
   durable-workflow/durable-workflow.github.io#269 payload/export lifetimes	Server #520: self-contained cold-verified history archives.
   durable-workflow/durable-workflow.github.io#285 update recovery	Shared #212: pending/read-later outcomes plus embedded and continue-as-new inspection.
   durable-workflow/durable-workflow.github.io#287 timeout compensation	Workflow #863: opt-in durable cleanup under an immutable total cap.

   These seven wrappers are closed as superseded, not as implemented product fixes. Their useful current-behavior corrections and final documentation are retained in the implementation acceptance. Prepared durable-workflow/durable-workflow.github.io#307 and durable-workflow/sdk-python#169 explicitly remain interim truth, not delivery of #215.

   Further product corrections and features

   • Server #519: guarded queue/build retirement behind Explain cohort backlog and worker-state metrics during rollouts durable-workflow.github.io#262, Correct promotion APIs, build pinning and rollback guidance durable-workflow.github.io#274, Explain recorded activity queues and existing routing diagnostics durable-workflow.github.io#308. Keep their real current promotion/metric/queue documentation.
   • Server #521: actual promotion operation missing from the current OpenAPI intent contract; separate from guide prose.
   • Server #522: prospective retention impact planning/guarded application, following the intentional current behavior documented in Clarify how namespace retention changes affect existing history durable-workflow.github.io#264.
   • Python SDK #168 is reclassified in place as a supported local readiness/liveness status feature.
   • PHP SDK #185 is reclassified in place as an additive child execution-identity handle feature. Existing Support explicit instance IDs for service-mode child workflows workflow#850 retains explicit child-ID scope.
   • Existing shared #216 owns safe signal/update retries exposed by closed Document safe signal and update retries after ambiguous responses durable-workflow.github.io#266. Corrected its baseline: released Core 2.7.2/Server 2.9.7 already deduplicate ordinary updates; signal deduplication, portable key reuse, intent conflicts and remaining lifecycle/readback behavior are the actual work. External business-effect idempotency remains necessary.
   • Server #518 remains a P1 product fix, including safe get_version evolution under the default policy. Keeping old workers is not its resolution.

   This creates eight correctly owned new product tickets, expands two existing SDK tickets, and reuses the existing clock/update/timeout/identity defects instead of duplicating them. Every new ticket states evidence limits and concrete implementation/qualification acceptance.

   Genuine documentation retained

   durable-workflow/durable-workflow.github.io#169, durable-workflow/durable-workflow.github.io#256, durable-workflow/durable-workflow.github.io#257, durable-workflow/durable-workflow.github.io#259, durable-workflow/durable-workflow.github.io#262, durable-workflow/durable-workflow.github.io#267, durable-workflow/durable-workflow.github.io#270, durable-workflow/durable-workflow.github.io#274, durable-workflow/durable-workflow.github.io#276, durable-workflow/durable-workflow.github.io#278, durable-workflow/durable-workflow.github.io#280, durable-workflow/durable-workflow.github.io#283, durable-workflow/durable-workflow.github.io#301, durable-workflow/durable-workflow.github.io#308 remain documentation or executable-example work on existing capabilities, with a recorded reason in each issue. Related actual defects remain linked, including durable-workflow/server#504 and durable-workflow/server#514 and durable-workflow/workflow#856 and durable-workflow/workflow#859. Removed the stale claim that delivered SQS chunking durable-workflow/workflow#851 is still open. durable-workflow/durable-workflow.github.io#277 is closed as actually delivered through durable-workflow/durable-workflow.github.io#291 and verified public publication; no unsupported sticky-owner hold was invented.

   Retry-default decision: keep one attempt for current 2.x applications. Automatically repeating external effects is a compatibility change; finite retries do not establish idempotency. durable-workflow/durable-workflow.github.io#301, durable-workflow/durable-workflow.github.io#304 must accurately show explicit bounded retry/backoff and total budgets. No automatic retry-default change was accepted for this train.

   The shared contributor rule is delivered through #214 at 3e950f03fb64a78667702c5fe909ec0a5d5eee9c. This audit closes triage, not the newly accepted implementations. Product tickets remain open until their real acceptance is delivered.