Add missing cross-links and fix tone in the design-patterns catalog - #5254
Draft
Duncanma wants to merge 1 commit into
Draft
Add missing cross-links and fix tone in the design-patterns catalog#5254Duncanma wants to merge 1 commit into
Duncanma wants to merge 1 commit into
Conversation
Cross-links (from the Tier B review's "missing cross-links" list):
- best-practices/multi-tenant-patterns.mdx now links back to
design-patterns/fairness.mdx and priority-task-queues.mdx from its
"Single Task Queue with Fairness" section — the reverse direction
already existed (fairness.mdx links to multi-tenant-patterns.mdx)
but not this one.
- child-workflows.mdx -> /parent-close-policy and the four per-SDK
child-workflows how-to guides.
- signal-with-start.mdx, request-response-via-updates.mdx ->
/sending-messages and /handling-messages.
- pick-first.mdx -> /develop/go/workflows/selectors (same underlying
Go Selector construct, same sample repo).
- parallel-execution.mdx -> /troubleshooting/blob-size-limit-error and
/workflow-execution/limits.
- fixed-wall-time-retries.mdx -> /encyclopedia/detecting-activity-failures
(defines ScheduleToCloseTimeout/StartToCloseTimeout).
- fast-slow-retries.mdx, retry-metrics.mdx, resumable-activity.mdx ->
/encyclopedia/retry-policies, matching their sibling pages.
- activity-dependency-injection.mdx -> the Go/TypeScript Activity DI
how-tos and best-practices/worker.mdx.
- updatable-timer.mdx -> /develop/typescript/workflows/timers, which
documents the same UpdatableTimer class via the temporal-time-utils
package.
- long-running-activity.mdx, polling.mdx ->
/encyclopedia/detecting-activity-failures#activity-heartbeat.
- delayed-callback.mdx -> /activity-execution#asynchronous-activity-completion.
- delayed-start.mdx, continue-as-new.mdx -> /schedule, and linked the
existing unlinked "Temporal Schedules" bullet in delayed-start.mdx.
All new anchor links verified against the built HTML output directly
(yarn check-links flags them as "fragment-redirect" false positives —
it doesn't parse the unquoted id= attributes Docusaurus emits).
Tone fixes:
- resumable-activity.mdx and fast-slow-retries.mdx: removed a
narrative-climax line ("the Workflow never died") and a
self-congratulatory flourish ("exactly what a Temporal Workflow
is"), replaced with plain factual statements.
- downstream-rate-limiting.mdx: cut a Problem-section sentence that
only restated the one before it.
- worker-specific-taskqueue.mdx, activity-dependency-injection.mdx:
reformatted "When to use" (and, for the former, "Benefits and
trade-offs") from run-on sentences stacking 4-5 unrelated items into
bulleted Good-fit/Poor-fit lists, matching every sibling page's
template.
- continue-as-new.mdx, long-running-activity.mdx, entity-workflow.mdx,
polling.mdx, delayed-start.mdx, updatable-timer.mdx: rewrote the
templated "you often need X1, X2, X3, X4, and X5 ... without it you
must A1, A2, A3, and A4" Problem-section opener into plain prose,
preserving every fact.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
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
Stacked on #5246 (Tier B). Remaining Tier B findings from the design-patterns review: the missing cross-links list and the tone findings.
Cross-links
best-practices/multi-tenant-patterns.mdxnow links back todesign-patterns/fairness.mdxandpriority-task-queues.mdxfrom its "Single Task Queue with Fairness" section — the reverse direction already existed (fairness.mdxlinks tomulti-tenant-patterns.mdx) but not this one.child-workflows.mdx→/parent-close-policyand the four per-SDK child-workflows how-to guides.signal-with-start.mdx,request-response-via-updates.mdx→/sending-messagesand/handling-messages.pick-first.mdx→/develop/go/workflows/selectors(same underlying GoSelectorconstruct, same sample repo).parallel-execution.mdx→/troubleshooting/blob-size-limit-errorand/workflow-execution/limits.fixed-wall-time-retries.mdx→/encyclopedia/detecting-activity-failures(definesScheduleToCloseTimeout/StartToCloseTimeout).fast-slow-retries.mdx,retry-metrics.mdx,resumable-activity.mdx→/encyclopedia/retry-policies, matching their sibling pages.activity-dependency-injection.mdx→ the Go/TypeScript Activity DI how-tos andbest-practices/worker.mdx.updatable-timer.mdx→/develop/typescript/workflows/timers, which documents the sameUpdatableTimerclass via thetemporal-time-utilspackage.long-running-activity.mdx,polling.mdx→/encyclopedia/detecting-activity-failures#activity-heartbeat.delayed-callback.mdx→/activity-execution#asynchronous-activity-completion.delayed-start.mdx,continue-as-new.mdx→/schedule, and linked the existing unlinked "Temporal Schedules" bullet indelayed-start.mdx.All new anchor links were verified against the built HTML output directly —
yarn check-linksflags them as "fragment-redirect" false positives, since it doesn't parse the unquotedid=attributes Docusaurus emits in minified HTML.Tone
resumable-activity.mdxandfast-slow-retries.mdx: removed a narrative-climax line ("the Workflow never died") and a self-congratulatory flourish ("exactly what a Temporal Workflow is"), replaced with plain factual statements.downstream-rate-limiting.mdx: cut a Problem-section sentence that only restated the one before it.worker-specific-taskqueue.mdx,activity-dependency-injection.mdx: reformatted "When to use" (and, for the former, "Benefits and trade-offs") from run-on sentences stacking 4-5 unrelated items into bulleted Good-fit/Poor-fit lists, matching every sibling page's template.continue-as-new.mdx,long-running-activity.mdx,entity-workflow.mdx,polling.mdx,delayed-start.mdx,updatable-timer.mdx: rewrote the templated "you often need X1, X2, X3, X4, and X5 ... without it you must A1, A2, A3, and A4" Problem-section opener into plain prose, preserving every fact.Test plan
vale --config .vale-ci.ini docs/clean on every touched fileyarn buildsucceeds#activity-heartbeat,#asynchronous-activity-completion, etc.) confirmed present in the built HTML