Conversation
- Created `install-user-rust.sh` for installing Rust runtime. - Created `setup-user-configs.sh` to configure user shell environments (bash and zsh). - Created `setup-user-env.sh` to set up the user development environment. - Created `setup-user-nvchad.sh` for installing and configuring NvChad. - Created `setup-user-ohmyzsh.sh` for installing Oh My Zsh and its plugins. - Created `setup-user-workspaces.sh` to create and manage user workspaces. - Added placeholder files for Windows setup and configs.
bybatkhuu
added
documentation
There was a problem hiding this comment.
Pull Request Overview
This PR introduces significant improvements to the documentation and onboarding experience for the script-common repository. The primary focus is on replacing individual installation scripts with comprehensive setup scripts that streamline environment configuration across Unix-based systems. The changes include a complete documentation overhaul, removal of outdated scripts, and introduction of new user-friendly setup workflows for Linux and macOS platforms.
Key Changes:
- Complete rewrite of README.md and docs/README.md with modern onboarding instructions and practical usage examples
- Addition of comprehensive setup scripts for Ubuntu/Debian, macOS, and cross-platform Unix environments
- Removal of deprecated installation and setup scripts in favor of consolidated setup workflows
- Addition of account management scripts for user and group operations on Linux systems
Reviewed Changes
Copilot reviewed 54 out of 57 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md, docs/README.md | Updated with practical usage examples and improved feature descriptions |
| src/setup/unix/setup-user-env.sh | Main orchestrator for user environment setup across platforms |
| src/setup/unix/setup-user-ohmyzsh.sh | Configures Oh My Zsh with plugins and themes |
| src/setup/unix/setup-user-configs.sh | Sets up shell configurations and user-level settings |
| src/setup/unix/setup-user-workspaces.sh | Creates standardized workspace directory structures |
| src/setup/unix/setup-user-nvchad.sh | Installs and configures NvChad for Neovim |
| src/setup/unix/runtimes/* | Runtime installation scripts for Rust, Go, NVM, and Miniconda |
| src/setup/unix/linux/ubuntu/* | Ubuntu/Debian-specific setup scripts and package installers |
| src/setup/unix/linux/setup-user.sh | User account creation and environment setup on Linux |
| src/setup/unix/linux/setup-docker.sh | Docker installation and configuration with NVIDIA container support |
| src/setup/unix/macos/* | macOS-specific setup scripts with Homebrew integration |
| src/account/unix/linux/* | Account management utilities for creating/deleting users and groups |
| scripts/* | Updated utility scripts with improved error handling and standards |
| CHANGELOG.md | Added changelog tracking for version v0.0.1-251009 |
| Removed files | Deprecated standalone installation and setup scripts |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
src/setup/unix/setup-user-configs.sh
Outdated
|
|
||
| if ! grep -q '### CUSTOM CONFIGS ###' "${HOME}/.zshrc"; then | ||
| echo "[INFO]: Updating '.zshrc' file..." | ||
| echo "${_CUSTOM_CONFIGS}" >> "${HOME}/.zshrc" || exit |
There was a problem hiding this comment.
Inconsistent exit code on line 201. This line uses exit without a code, while all other similar lines in the file use exit 2. This should be exit 2 to maintain consistency and proper error reporting.
Suggested change
| echo "${_CUSTOM_CONFIGS}" >> "${HOME}/.zshrc" || exit | |
| echo "${_CUSTOM_CONFIGS}" >> "${HOME}/.zshrc" || exit 2 |
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 introduces significant improvements to the documentation and onboarding experience for the
script-commonrepository. The README and documentation have been completely rewritten for clarity, modern onboarding, and better usability, including step-by-step usage examples and prerequisites. Several outdated or redundant documentation files have been removed. Additionally, a changelog has been added, and the release workflow has been renamed for clarity.Documentation overhaul and onboarding improvements:
README.mdanddocs/README.mdto provide clear, modern onboarding instructions, usage examples for different platforms (Linux, macOS), prerequisites, and improved feature listings. The documentation now focuses on practical usage and setup scenarios. [1] [2] [3]README.mdwith additional helpful links and resources for shell scripting and terminal tools.Removal of outdated or redundant documentation:
docs/install/install-docker.md,docs/install/install-essentials.md, anddocs/install/install-ohmyzsh.md, consolidating essential usage information into the main README and streamlining documentation. [1] [2] [3]Changelog and workflow updates:
CHANGELOG.mdto track releases and notable changes, starting with version v0.0.1-251009.