Open
Conversation
fix: reword a bit fix: rename page fix: rewrite a bit more fix: more wording, sdk specifics fix: more wording fix: rm guides chore: add tsbuildinfo to gitignore fix: rm unhelpful entry from table fix: more rework
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the “durable execution” documentation set by consolidating/renaming pattern pages, updating internal links, and refreshing some explanatory text so the “durable tasks vs DAGs” story is simpler and less redundant.
Changes:
- Replaces older “Durable Execution” / “Best Practices” pattern pages with a new Durable Tasks page and an updated Workflow Design index.
- Updates various docs links/navigation labels and search-quality expectations to reflect the new structure.
- Updates SDK non-determinism error messages to point to the new docs location.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| sdks/typescript/src/util/errors/non-determinism-error.ts | Updates durable-task expectations doc link in error text. |
| sdks/python/hatchet_sdk/exceptions.py | Updates durable-task expectations doc link in error text. |
| frontend/docs/scripts/test-search-quality.ts | Adjusts search test expectations for the new docs structure. |
| frontend/docs/pages/v1/tasks.mdx | Adds SDK-specific clarification about task function signatures/args. |
| frontend/docs/pages/v1/task-eviction.mdx | Updates links to determinism/durable-task docs. |
| frontend/docs/pages/v1/patterns/mixing-patterns.mdx | Removes the old “Best Practices” page. |
| frontend/docs/pages/v1/patterns/index.mdx | Rewrites the patterns landing page as “Workflow Design” and updates links. |
| frontend/docs/pages/v1/patterns/durable-tasks.mdx | Adds the new consolidated Durable Tasks page. |
| frontend/docs/pages/v1/patterns/durable-task-execution.mdx | Removes the old durable-task execution page. |
| frontend/docs/pages/v1/patterns/directed-acyclic-graphs.mdx | Simplifies and renames sections/headings for the DAGs page. |
| frontend/docs/pages/v1/patterns/_meta.js | Updates patterns nav metadata to new page keys/titles. |
| frontend/docs/pages/v1/durable-execution.mdx | Updates internal linking to the new Durable Tasks page. |
| frontend/docs/pages/v1/conditions.mdx | Updates determinism reference link to the new Durable Tasks page. |
| frontend/docs/pages/v1/child-spawning.mdx | Rewrites intro/section titles and adjusts explanatory wording. |
| frontend/docs/pages/v1/_meta.js | Renames sidebar section titles to match new information architecture. |
| frontend/docs/next.config.mjs | Adjusts redirect for durable best practices. |
| frontend/docs/.gitignore | Ignores tsconfig.tsbuildinfo for docs app. |
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.
Description
Reworking the first batch of durable execution docs to try to simplify them, remove some redundancy, clarify some things, improve internal linking, etc.
Type of change