chore: add missing sections #263
Conversation
|
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
|
View your CI Pipeline Execution ↗ for commit d944958
☁️ Nx Cloud last updated this comment at |
🔍 Preview Deployment: Website✅ Deployment successful! 🔗 Preview URL: https://pr-263.pgflow.pages.dev 📝 Details:
_Last updated: _ |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| { | ||
| label: 'Configuring retries', | ||
| link: '/build/configuring-retries/', | ||
| label: 'Retrying steps', | ||
| link: '/build/retrying-steps/', | ||
| }, | ||
| { | ||
| label: 'Validation steps', | ||
| link: '/build/validation-steps/', |
There was a problem hiding this comment.
The page rename to /build/retrying-steps/ updates the navigation, but there is no corresponding redirect entry for the previous /build/configuring-retries/ URL. Any external links, bookmarks, or cached search results for the old path will now return 404s. The documentation guidelines in CLAUDE.md require adding redirects when renaming pages. Please add a mapping in redirects.config.mjs to forward /build/configuring-retries/ to /build/retrying-steps/ so historical links continue to work.
Useful? React with 👍 / 👎.
🔍 Preview Deployment: Playground✅ Deployment successful! 🔗 Preview URL: https://pr-263--pgflow-demo.netlify.app 📝 Details:
_Last updated: _ |
Merge activity
|
### TL;DR Renamed "Configuring Retries" to "Retrying Steps" and added a new "Validation Steps" guide to improve documentation around error handling patterns. ### What changed? - Renamed `/build/configuring-retries/` to `/build/retrying-steps/` for better clarity - Added a new guide on `/build/validation-steps/` explaining how to properly handle validation errors - Enhanced the retry documentation with sections on understanding different failure types - Updated all internal links and navigation references to point to the renamed pages - Refined the LLM content exclusion list in `astro.config.mjs` to be more specific about which index pages to exclude ### How to test? 1. Build the website and verify the new page structure: - Confirm `/build/retrying-steps/` loads correctly with the enhanced content - Verify the new `/build/validation-steps/` page is accessible - Check that all links to the old "Configuring Retries" page redirect properly 2. Review the content of both pages to ensure they provide clear guidance on: - Distinguishing between transient and permanent failures - Setting up validation steps with `maxAttempts: 1` - Following best practices for synchronous validation ### Why make this change? Users were confused about when to use retries versus when to fail fast. The documentation needed clearer guidance on handling different types of errors appropriately. By separating validation patterns into their own guide and enhancing the retry documentation, we provide more specific guidance on error handling best practices, helping users build more robust flows that don't waste resources on unnecessary retries.
TL;DR
Renamed "Configuring Retries" to "Retrying Steps" and added a new "Validation Steps" guide to improve documentation around error handling patterns.
What changed?
/build/configuring-retries/to/build/retrying-steps/for better clarity/build/validation-steps/explaining how to properly handle validation errorsastro.config.mjsto be more specific about which index pages to excludeHow to test?
Build the website and verify the new page structure:
/build/retrying-steps/loads correctly with the enhanced content/build/validation-steps/page is accessibleReview the content of both pages to ensure they provide clear guidance on:
maxAttempts: 1Why make this change?
Users were confused about when to use retries versus when to fail fast. The documentation needed clearer guidance on handling different types of errors appropriately. By separating validation patterns into their own guide and enhancing the retry documentation, we provide more specific guidance on error handling best practices, helping users build more robust flows that don't waste resources on unnecessary retries.