docs: improve background processes documentation clarity #9076
+21
−20
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
- 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 <[email protected]>
dosubot
bot
added
the
size:M
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
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.
This PR improves the documentation clarity for the beta background process execution feature by making it more user-focused and consistent with other CLI documentation.
Changes
spawn" and "gracefulExit()handler" - these are internal details better suited for developer documentationRationale
The documentation now matches the style and technical level of other CLI docs (e.g.,
/docs/cli/overview.mdx), focusing on what users can accomplish rather than how it's implemented internally.This agent session was co-authored by nate and Continue.
Summary by cubic
Clarifies the beta background process docs by switching examples from TypeScript to JSON, removing internal implementation details, and simplifying workflow steps. Aligns the page with other CLI docs and makes it easier for users to understand what the agent can do.
Written for commit cca82c8. Summary will update automatically on new commits.