Open
Conversation
claymcleod
requested changes
Feb 19, 2026
Contributor
claymcleod
left a comment
claymcleod
left a comment
There was a problem hiding this comment.
Thanks for putting this together — having a best practices guide on the docs site is a great addition. A few thoughts below.
| - mutually exclusive parameters | ||
| - missing optional file for selected parameters | ||
| - filename extensions | ||
| - Use `after` clauses in workflows to ensure that all these assumptions are valid before beginning tasks with heavy computation. |
Contributor
There was a problem hiding this comment.
The after clause is a useful feature but isn't currently documented anywhere on the docs site. Would you mind adding a section about after clauses to the Workflows page in the Language Guide and linking to it from here?
| text: "Getting Started", | ||
| items: [ | ||
| { text: "Quickstart", link: "/getting-started/quickstart" }, | ||
| { text: "Best Practices", link: "/getting-started/best-practices" }, |
Contributor
There was a problem hiding this comment.
I'm not sure "Getting Started" is the right home for this — would you mind moving it to a new top-level "Guides" section between Design Patterns and Reference?
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
2 participants
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.
This PR adds a set of "WDL Best Practices" to the getting started section of the site. These best practices are agnostic of backend or engine.
The best practices herein were originally written for the St. Jude Cloud
workflowsrepo (and are currently hosted there - https://github.com/stjudecloud/workflows/blob/77be0a72244209db1e08d289658233c476f5affa/best-practices.md ), but I think this site is a much better long term home for them!The current document is just an exact copy of what we have on
workflows, but maybe it needs some more elaboration or editorializing? Happy to discuss and edit as needed, but figure this is a good jumping off point!