docs: add beta background process execution documentation#9075
Closed
continue[bot] wants to merge 3 commits intonate/beta-background-process-toolsfrom
Closed
docs: add beta background process execution documentation#9075continue[bot] wants to merge 3 commits intonate/beta-background-process-toolsfrom
continue[bot] wants to merge 3 commits intonate/beta-background-process-toolsfrom
Conversation
- Added new documentation page for beta background process tools - Updated CLI overview to link to background processes documentation - Added page to docs.json navigation structure Co-authored-by: nate <nate@continue.dev> Generated with [Continue](https://continue.dev) Co-Authored-By: Continue <noreply@continue.dev>
- Replace TypeScript syntax with JSON in tool examples for user clarity - Remove implementation details (Node.js spawn, gracefulExit handler) - Simplify workflow steps to focus on capabilities rather than code - Maintain consistent technical documentation level Co-authored-by: nate <nate@continue.dev>
Contributor
Author
|
I've created PR #9076 with documentation improvements to enhance clarity and maintain consistency with other CLI documentation. The changes focus on making the docs more user-focused by:
These changes maintain the same technical level as other CLI docs while improving readability for end users. |
…-processes docs: improve background processes documentation clarity
Collaborator
|
The docs for this feature will likely be no more than a couple paragraphs, i think this PR is overkill, and the original PR is still in draft state so this is subject to change. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adds user-facing documentation for the beta background process execution feature introduced in PR #9074.
Changes
Created new documentation page
/docs/cli/beta-background-processes.mdxcovering:--beta-persistent-terminal-toolsBash(withrun_in_background),BashOutput,ListProcesses,KillProcessUpdated
/docs/cli/overview.mdxto link to background process documentation in the Tool Integration sectionUpdated
/docs/docs.jsonto include the new page in CLI navigationDocumentation Approach
The documentation maintains the same level of detail as existing CLI docs, focusing on practical usage and clear examples rather than implementation details. The internal
BACKGROUND_PROCESSES.mdfile remains as developer documentation.This agent session was co-authored by nate and Continue.
Summary by cubic
Added a new CLI docs page for Background Process Execution (beta) showing how to enable the feature (--beta-persistent-terminal-tools) and use Bash run_in_background, BashOutput, ListProcesses, and KillProcess, with examples, technical details, and limitations. Updated the CLI overview to link the page and added it to the docs navigation.
Written for commit c010d06. Summary will update on new commits.