docs: Expand man pages with workflow examples and tips #191
+457
−91
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
Our man pages were pretty dry; let's include more background information in them, and clarify things more. Assisted-by: OpenCode (Sonnet 4) Signed-off-by: Colin Walters <walters@verbum.org>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly enhances the documentation for bcvk and its ephemeral subcommands. The man pages are now much more comprehensive, featuring detailed descriptions, practical examples, lifecycle explanations, and troubleshooting tips. This greatly improves the clarity and usability of the tool's documentation for users. The code changes in run_ephemeral_ssh.rs and run_ephemeral.rs appear to correctly implement the described functionality, including robust cleanup mechanisms and improved VM boot monitoring.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Our man pages were pretty dry; let's include more background information in them, and clarify things more.
Assisted-by: OpenCode (Sonnet 4)