docs: adding more comprehensive documentation #130
Merged
Conversation
This file contains 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
grabbou
changed the title
kraenhansen
reviewed
Dec 16, 2024
|
|
||
| ### Workflows | ||
| Final Boss, `finalBoss`, is responsible for wrapping up the workflow and providing a final output, | ||
| in case total number of iterations exeeceds available threshold. |
There was a problem hiding this comment.
Suggested change
| in case total number of iterations exeeceds available threshold. | |
| in case the total number of iterations exceeds a threshold of available iterations. |
| /** read state from the cache */ | ||
|
|
||
| /** run the workflow */ | ||
| const state = await teamwork(workflow, prevState, false) |
There was a problem hiding this comment.
Positional boolean arguments are an endless source of bugs and confusion. I'd suggest changing that API to take an options object, even if it only has a single option at this time.
const state = await teamwork(workflow, prevState, { executeTools: false })
There was a problem hiding this comment.
@grabbou ? If so maybe let's make a task out if this suggestion
There was a problem hiding this comment.
Yeah, good idea! Thanks @kraenhansen!
|
|
||
| Passing second argument to `teamwork` is optional. If you don't provide it, root state will be created automatically. Otherwise, it will be used as a starting point for the next iteration. | ||
|
|
||
| Last argument is a boolean flag that determines if tools should be executed. If you set it to `false`, you are responsible for calling tools manually. Teamwork will stop iterating over the workflow and return the current state with `paused` status. |
There was a problem hiding this comment.
This should be updated if you choose to alter the teamwork function to take a third optional options object.
Co-authored-by: Kræn Hansen <[email protected]>
Co-authored-by: Kræn Hansen <[email protected]>
Co-authored-by: Kræn Hansen <[email protected]>
Co-authored-by: Kræn Hansen <[email protected]>
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.
We've added a bunch of features lately, so let's make sure we document them all!