Skip to content

docs: add beta background process execution documentation#9075

Closed
continue[bot] wants to merge 3 commits intonate/beta-background-process-toolsfrom
docs/beta-background-process-tools
Closed

docs: add beta background process execution documentation#9075
continue[bot] wants to merge 3 commits intonate/beta-background-process-toolsfrom
docs/beta-background-process-tools

Conversation

@continue
Copy link
Contributor

@continue continue bot commented Dec 8, 2025

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.mdx covering:

    • Overview and motivation for background processes
    • How to enable the beta feature with --beta-persistent-terminal-tools
    • Available tools: Bash (with run_in_background), BashOutput, ListProcesses, KillProcess
    • Example workflows for common use cases
    • Technical details and limitations
    • Feedback channels
  • Updated /docs/cli/overview.mdx to link to background process documentation in the Tool Integration section

  • Updated /docs/docs.json to include the new page in CLI navigation

Documentation 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.md file 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.

- 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>
@continue continue bot requested a review from a team as a code owner December 8, 2025 22:36
@continue continue bot requested review from sestinj and removed request for a team December 8, 2025 22:36
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Dec 8, 2025
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

- 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>
@continue
Copy link
Contributor Author

continue bot commented Dec 8, 2025

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:

  • Replacing TypeScript syntax with JSON in tool examples (since users interact through the AI, not directly with code)
  • Removing implementation details like Node.js spawn and gracefulExit() handler
  • Simplifying workflow descriptions to focus on capabilities rather than code syntax

These changes maintain the same technical level as other CLI docs while improving readability for end users.

…-processes

docs: improve background processes documentation clarity
@RomneyDa
Copy link
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.

@RomneyDa RomneyDa closed this Jan 13, 2026
@github-project-automation github-project-automation bot moved this from Todo to Done in Issues and PRs Jan 13, 2026
@github-actions github-actions bot locked and limited conversation to collaborators Jan 13, 2026
@RomneyDa RomneyDa deleted the docs/beta-background-process-tools branch February 2, 2026 21:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

size:L This PR changes 100-499 lines, ignoring generated files.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant