Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation and script references to improve clarity and consistency. The main changes standardize command-line flag usage in examples and rename a configuration script to better reflect its purpose.
- Standardized runtime selection flags from
-a/--all-runtimesto-r all/--runtimes=allacross all usage examples - Renamed
setup-user-configs.shtosetup-user-dotfiles.shfor improved clarity - Added comprehensive script reference tables documenting all available setup, development environment, and account management scripts
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Added script reference tables and updated all usage examples to use standardized -r all/--runtimes=all flags |
| src/setup/unix/setup-user-env.sh | Updated script reference from setup-user-configs.sh to setup-user-dotfiles.sh |
| src/setup/unix/linux/ubuntu/setup-ubuntu.sh | Updated script reference from setup-user-configs.sh to setup-user-dotfiles.sh |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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 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 pull request updates the documentation and scripts to improve clarity and consistency around available setup scripts and their usage. The most important changes are the addition of a comprehensive script reference table in the
README.md, standardization of runtime selection flags in usage examples, and renaming of a user configuration script for clarity.Documentation improvements:
README.mdlisting all available setup, development environment, and account management scripts, including descriptions, supported OS, sudo requirements, and links to documentation.Usage consistency:
-a/--all-runtimesto-r all/--runtimes=allfor all setup commands inREADME.md. [1] [2]Script naming/clarity:
setup-user-configs.shtosetup-user-dotfiles.shin bothsetup-ubuntu.shandsetup-user-env.shscripts to better reflect its purpose and improve clarity for users. [1] [2]