docs: Add Conversational Flows (self.ask) documentation#5220
Open
iris-clawd wants to merge 6 commits intomainfrom
Open
docs: Add Conversational Flows (self.ask) documentation#5220iris-clawd wants to merge 6 commits intomainfrom
iris-clawd wants to merge 6 commits intomainfrom
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
lorenzejay
approved these changes
Apr 1, 2026
lorenzejay
approved these changes
Apr 1, 2026
Add comprehensive documentation for the self.ask() feature covering: - Basic usage and API - Multiple asks in a single method - Timeout support with retry pattern - Bidirectional metadata support - Custom InputProvider protocol (Slack example) - Auto-checkpoint behavior with persistence - Comparison table: self.ask() vs @human_feedback
033cdd2 to
f789cf8
Compare
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
Adds a new Conversational Flows (User Input) section to the Flows documentation, covering the
self.ask()feature for inline user input during flow execution.What's covered
timeout=parameter,Noneon expiry, retry loop patternself.ask()vs@human_feedback(when to use which)Placement
Inserted immediately before the existing "Human in the Loop (human feedback)" section to keep the two HITL-related features adjacent.
API
Note
Low Risk
Low risk: changes are limited to documentation content and a CI workflow adjustment; the main risk is the broken-link check failing if the Mintlify CLI/environment assumptions are off.
Overview
Adds a new Conversational Flows (User Input) section to
docs/en/concepts/flows.mdx, documentingself.ask()with examples for multiple prompts, timeouts/retries, metadata, customInputProviders, auto-checkpointing, and a comparison to@human_feedback.Updates the docs broken-link GitHub Action to watch
docs/docs.json(instead ofdocs.json) and to run the link checker via the newermintCLI, including installinglibsecret-1-0to satisfy runtime dependencies.Written by Cursor Bugbot for commit f789cf8. This will update automatically on new commits. Configure here.