docs(cli): add docs for all remaining commands #2207
Closed
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
This was referenced Mar 14, 2025
Deploying rivet with
|
| Latest commit: |
9d13f5d
|
| Status: | 🚫 Build failed. |
Deploying rivet-hub with
|
| Latest commit: |
9d13f5d
|
| Status: | 🚫 Build failed. |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR adds comprehensive documentation to the Rivet CLI command modules, improving code clarity and usability.
- Added descriptive doc comments to all CLI command modules in
/packages/toolchain/cli/src/commands/following Rust documentation standards - Documented command-line options and parameters in
Optsstructs across various commands likeactor,deploy,environment - Added clear descriptions for subcommands in module-level
SubCommandenums - Maintained consistent documentation style across all command modules while preserving existing functionality
- Added helpful context about command purposes and options without modifying implementation logic
19 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
NathanFlurry
force-pushed
the
03-14-docs_cli_add_docs_for_all_remaining_commands
branch
from
9d13f5d to
67a8ef2
Compare
NathanFlurry
force-pushed
the
03-14-chore_examples_remove_old_configs
branch
from
3630ed2 to
5b573fd
Compare
Closed
Merge activity
|
graphite-app bot
pushed a commit
that referenced
this pull request
Mar 14, 2025
<!-- Please make sure there is an issue that this PR is correlated to. --> ## Changes <!-- If there are frontend changes, please include screenshots. -->
graphite-app
bot
deleted the
03-14-docs_cli_add_docs_for_all_remaining_commands
branch
This was referenced Mar 20, 2025
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.
Changes