docs: add guidance for intentional ask_user pauses - #159
Open
PayalVerma1 wants to merge 1 commit into
Open
Conversation
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
ask_user.### Runtime: interactive: truefield.ask_userbehavior and linked it from the examples index.Fixes #105
Why
The existing documentation describes
ask_useronly as an automatic VM input-binding mechanism. It does not clearly explain how authors intentionally build interactive services, making this behavior difficult to discover.As a result, contributors inferred a non-existent
### Runtime: interactive: trueoption because there was no author-facing guidance or interactive example to follow.This PR closes that documentation gap without changing language semantics or runtime behavior.
What Changed
Documentation
Added an Interactive Authoring section to
skills/open-prose/guidance/authoring.mdexplaining:ask_usershould be used,unresolved-intentrather than fabricated input).Added Intentional ask_user Pauses to
skills/open-prose/prose.md, documenting the recommended authoring pattern:ask_user, bind the response, and resume execution.The section also explicitly clarifies that
### Runtime: interactive: trueis not part of the language.Examples
interactive-grillexample showing an intentionally interactive responsibility that pauses for user input.Design Boundary
This PR is documentation and examples only.
It does not modify:
Testing
pnpm buildpnpm test:skillResults:
Follow-ups
This PR intentionally addresses only the documentation/discoverability gap described in #105.
The host-specific interaction behavior (structured vs. plain-chat questioning) and the potential run-log improvements mentioned in the issue remain separate concerns and are better addressed in future issues or PRs.