Fix design-patterns frontmatter, drift, and a stale limit - #5245
Open
Duncanma wants to merge 4 commits into
Open
Fix design-patterns frontmatter, drift, and a stale limit#5245Duncanma wants to merge 4 commits into
Duncanma wants to merge 4 commits into
Conversation
- Add the missing Event Accumulator card to the design-patterns index (present in sidebars.js but absent from the landing page). - Rewrite 13 meta descriptions that fell outside the site's 120-155 character target, and sync the matching PatternCards blurbs on the top-level index and sub-category index pages so they don't drift from the frontmatter they were copied from. - Fix continue-as-new.mdx's "50,000 event history limit" to the documented 51,200 (docs/encyclopedia/workflow/workflow-execution/limits.mdx). - Remove a dangling "In the future - Org-to-Org Nexus, stay tuned" bullet from delayed-callback.mdx (future promise, no actual link).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
4 tasks
Contributor
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Several stale limit references and copied card blurbs remain elsewhere in the documentation.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates design-pattern documentation metadata and landing-page summaries to reduce drift and remove stale content.
Changes:
- Rewrites 13 meta descriptions and related card blurbs.
- Adds Event Accumulator to the main index.
- Corrects one Event History limit and removes a future-facing placeholder.
File summaries
| File | Description |
|---|---|
docs/design-patterns/workflow-messaging-patterns.mdx |
Updates the Updates pattern blurb. |
docs/design-patterns/task-orchestration-patterns.mdx |
Revises metadata and Pick First summary. |
docs/design-patterns/retry-metrics.mdx |
Shortens the meta description. |
docs/design-patterns/request-response-via-updates.mdx |
Expands the meta description. |
docs/design-patterns/qos-throughput-patterns.mdx |
Updates the rate-limiting summary. |
docs/design-patterns/pick-first.mdx |
Revises the meta description. |
docs/design-patterns/performance-latency-patterns.mdx |
Synchronizes latency-pattern blurbs. |
docs/design-patterns/local-activities.mdx |
Revises the meta description. |
docs/design-patterns/index.mdx |
Adds Event Accumulator and updates card blurbs. |
docs/design-patterns/fast-slow-retries.mdx |
Shortens the meta description. |
docs/design-patterns/external-interaction-patterns.mdx |
Revises metadata and webhook summary. |
docs/design-patterns/error-handling-patterns.mdx |
Updates retry-pattern blurbs. |
docs/design-patterns/entity-workflow.mdx |
Revises the meta description. |
docs/design-patterns/entity-lifecycle-patterns.mdx |
Updates the Entity Workflow summary. |
docs/design-patterns/early-return-local-activities.mdx |
Shortens the meta description. |
docs/design-patterns/eager-workflow-start.mdx |
Shortens the meta description. |
docs/design-patterns/downstream-rate-limiting.mdx |
Revises the meta description. |
docs/design-patterns/delayed-retry.mdx |
Shortens the meta description. |
docs/design-patterns/delayed-callback.mdx |
Updates metadata and removes a future promise. |
docs/design-patterns/continue-as-new.mdx |
Corrects the Event History limit. |
Review details
- Files reviewed: 20/20 changed files
- Comments generated: 3
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ## Problem | ||
|
|
||
| In long-running Workflows, you often need to execute periodic tasks indefinitely, process unbounded streams of data without accumulating history, implement infinite loops that run for months or years, avoid hitting the 50,000 event history limit, and maintain Workflow state across logical restarts. | ||
| In long-running Workflows, you often need to execute periodic tasks indefinitely, process unbounded streams of data without accumulating history, implement infinite loops that run for months or years, avoid hitting the 51,200 event history limit, and maintain Workflow state across logical restarts. |
Copilot's review of #5245 found the 50,000-event fix in continue-as-new.mdx didn't cover every collateral copy of that stale number, and 2 more PatternCards blurbs outside docs/design-patterns/ still had the pre-rewrite text. - Fix "50K"/"50,000" event history limit to 51,200 in child-workflows.mdx (2x), batch-iterator.mdx, fanout-child-workflows.mdx, signal-with-start.mdx, request-response-via-updates.mdx, parallel-execution.mdx, and docs/guides/durable-gaming-sessions.mdx (2x) — verified against docs/encyclopedia/workflow/workflow-execution/limits.mdx. - Sync the Entity Workflow and Local Activities PatternCards blurbs in docs/ai/index.mdx, which still had the exact pre-rewrite description text from the previous commit. Swept the rest of docs/ for both patterns to confirm no other copies remain.
Contributor
Author
|
Addressed in ec5e3bc:
Build and `vale --config .vale-ci.ini docs/` both clean on the new commit. |
Duncanma
marked this pull request as ready for review
September 4, 2026 17:59
Duncanma
enabled auto-merge (squash)
September 4, 2026 18:00
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.
Summary
Tier A (mechanical) findings from a full review of the
docs/design-patterns/section:sidebars.jsbut was missing from the landing page.PatternCardsblurbs on the top-level index and sub-category index pages so they don't drift from the frontmatter they were copied from.Test plan
vale --config .vale-ci.ini docs/clean on every touched fileyarn buildsucceeds