Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes the README documentation to improve the discoverability and clarity of setup scripts. The changes standardize script locations, update command-line argument syntax, and introduce better categorization by operating system and user scope.
Key changes:
- Reorganized script tables by OS (Ubuntu/Debian, Linux, macOS) and scope (system vs. user environment vs. user runtimes)
- Updated all usage examples to use
--runtimes=allinstead of deprecated-aor--all-runtimesflags - Moved user environment and runtime scripts from
runtimes/tosetup/unix/andsetup/unix/runtimes/directories
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| docs/README.md | Added badges, reorganized script tables with OS-specific groupings, updated usage examples with new flag syntax |
| README.md | Reorganized script tables to match docs/README.md structure with clearer categorization |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```sh | ||
| curl -fsSL https://github.com/humblebeeai/script-common/raw/main/src/setup/unix/linux/ubuntu/setup-ubuntu.sh | bash -s -- -u -a | ||
| curl -fsSL https://github.com/humblebeeai/script-common/raw/main/src/setup/unix/linux/ubuntu/setup-ubuntu.sh | bash -s -- -u -r all |
There was a problem hiding this comment.
The short flag syntax -r all is inconsistent with the long flag --runtimes=all shown elsewhere. Short flags typically don't accept space-separated values. This should be either -r=all or --runtimes=all to match the pattern used in other examples.
|
|
||
| ```sh | ||
| curl -fsSL https://github.com/humblebeeai/script-common/raw/main/src/setup/unix/linux/setup-user.sh | bash -s -- -a | ||
| curl -fsSL https://github.com/humblebeeai/script-common/raw/main/src/setup/unix/linux/setup-user.sh | bash -s -- -r all |
There was a problem hiding this comment.
The short flag syntax -r all is inconsistent with the long flag --runtimes=all shown elsewhere. Short flags typically don't accept space-separated values. This should be either -r=all or --runtimes=all to match the pattern used in other examples.
|
|
||
| ```sh | ||
| curl -fsSL https://github.com/humblebeeai/script-common/raw/main/src/setup/unix/macos/setup-macos.sh | bash -s -- -a | ||
| curl -fsSL https://github.com/humblebeeai/script-common/raw/main/src/setup/unix/macos/setup-macos.sh | bash -s -- -r all |
There was a problem hiding this comment.
The short flag syntax -r all is inconsistent with the long flag --runtimes=all shown elsewhere. Short flags typically don't accept space-separated values. This should be either -r=all or --runtimes=all to match the pattern used in other examples.
|
|
||
| ```sh | ||
| curl -fsSL https://github.com/humblebeeai/script-common/raw/main/src/setup/unix/setup-user-env.sh | bash -s -- -a | ||
| curl -fsSL https://github.com/humblebeeai/script-common/raw/main/src/setup/unix/setup-user-env.sh | bash -s -- -r all |
There was a problem hiding this comment.
The short flag syntax -r all is inconsistent with the long flag --runtimes=all shown elsewhere. Short flags typically don't accept space-separated values. This should be either -r=all or --runtimes=all to match the pattern used in other examples.
Comment on lines
+70
to
+73
| | `setup/unix/runtimes/install-user-miniconda.sh` | Install Miniconda and Python | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-miniconda.md) | | ||
| | `setup/unix/runtimes/install-user-nvm.sh` | Install NVM and Node.js | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-nvm.md) | | ||
| | `setup/unix/runtimes/install-user-rust.sh` | Install Rust toolchain and runtime | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-rust.md) | | ||
| | `setup/unix/runtimes/install-user-go.sh` | Install Go runtime | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-go.md) | |
There was a problem hiding this comment.
The documentation links still point to ./docs/runtimes/ but the script paths have been updated to setup/unix/runtimes/. The documentation links should be updated to match the new script organization, likely to paths like ./docs/setup/unix/runtimes/.
Suggested change
| | `setup/unix/runtimes/install-user-miniconda.sh` | Install Miniconda and Python | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-miniconda.md) | | |
| | `setup/unix/runtimes/install-user-nvm.sh` | Install NVM and Node.js | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-nvm.md) | | |
| | `setup/unix/runtimes/install-user-rust.sh` | Install Rust toolchain and runtime | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-rust.md) | | |
| | `setup/unix/runtimes/install-user-go.sh` | Install Go runtime | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-go.md) | | |
| | `setup/unix/runtimes/install-user-miniconda.sh` | Install Miniconda and Python | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/runtimes/install-user-miniconda.md) | | |
| | `setup/unix/runtimes/install-user-nvm.sh` | Install NVM and Node.js | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/runtimes/install-user-nvm.md) | | |
| | `setup/unix/runtimes/install-user-rust.sh` | Install Rust toolchain and runtime | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/runtimes/install-user-rust.md) | | |
| | `setup/unix/runtimes/install-user-go.sh` | Install Go runtime | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/runtimes/install-user-go.md) | |
Comment on lines
+65
to
+73
| | `setup/unix/setup-user-dotfiles.sh` | Apply dotfiles/configs | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-dotfiles.md) | | ||
| | `setup/unix/setup-user-nvchad.sh` | Install & setup NvChad for Neovim | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-nvchad.md) | | ||
|
|
||
| ### Setup user runtimes (per-user) | ||
|
|
||
| | `setup/unix/runtimes/install-user-miniconda.sh` | Install Miniconda and Python | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-miniconda.md) | | ||
| | `setup/unix/runtimes/install-user-nvm.sh` | Install NVM and Node.js | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-nvm.md) | | ||
| | `setup/unix/runtimes/install-user-rust.sh` | Install Rust toolchain and runtime | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-rust.md) | | ||
| | `setup/unix/runtimes/install-user-go.sh` | Install Go runtime | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-go.md) | |
There was a problem hiding this comment.
The documentation links still point to ./docs/runtimes/ but the script paths have been updated to setup/unix/runtimes/. The documentation links should be updated to match the new script organization, likely to paths like ./docs/setup/unix/runtimes/.
Suggested change
| | `setup/unix/setup-user-dotfiles.sh` | Apply dotfiles/configs | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-dotfiles.md) | | |
| | `setup/unix/setup-user-nvchad.sh` | Install & setup NvChad for Neovim | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-nvchad.md) | | |
| ### Setup user runtimes (per-user) | |
| | `setup/unix/runtimes/install-user-miniconda.sh` | Install Miniconda and Python | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-miniconda.md) | | |
| | `setup/unix/runtimes/install-user-nvm.sh` | Install NVM and Node.js | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-nvm.md) | | |
| | `setup/unix/runtimes/install-user-rust.sh` | Install Rust toolchain and runtime | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-rust.md) | | |
| | `setup/unix/runtimes/install-user-go.sh` | Install Go runtime | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/install-user-go.md) | | |
| | `setup/unix/setup-user-dotfiles.sh` | Apply dotfiles/configs | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-dotfiles.md) | | |
| | `setup/unix/setup-user-nvchad.sh` | Install & setup NvChad for Neovim | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-nvchad.md) | | |
| ### Setup user runtimes (per-user) | |
| | `setup/unix/runtimes/install-user-miniconda.sh` | Install Miniconda and Python | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/runtimes/install-user-miniconda.md) | | |
| | `setup/unix/runtimes/install-user-nvm.sh` | Install NVM and Node.js | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/runtimes/install-user-nvm.md) | | |
| | `setup/unix/runtimes/install-user-rust.sh` | Install Rust toolchain and runtime | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/runtimes/install-user-rust.md) | | |
| | `setup/unix/runtimes/install-user-go.sh` | Install Go runtime | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/runtimes/install-user-go.md) | |
Comment on lines
+62
to
+66
| | `setup/unix/setup-user-env.sh` | Setup user development environment | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-env.md) | | ||
| | `setup/unix/setup-user-workspaces.sh` | Create standard workspaces directories | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-workspaces.md) | | ||
| | `setup/unix/setup-user-ohmyzsh.sh` | Install Oh My Zsh & plugins | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-ohmyzsh.md) | | ||
| | `setup/unix/setup-user-dotfiles.sh` | Apply dotfiles/configs | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-dotfiles.md) | | ||
| | `setup/unix/setup-user-nvchad.sh` | Install & setup NvChad for Neovim | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-nvchad.md) | |
There was a problem hiding this comment.
The documentation links still point to ./docs/runtimes/ but the script paths have been updated to setup/unix/. The documentation links should be updated to match the new script organization, likely to paths like ./docs/setup/unix/.
Suggested change
| | `setup/unix/setup-user-env.sh` | Setup user development environment | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-env.md) | | |
| | `setup/unix/setup-user-workspaces.sh` | Create standard workspaces directories | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-workspaces.md) | | |
| | `setup/unix/setup-user-ohmyzsh.sh` | Install Oh My Zsh & plugins | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-ohmyzsh.md) | | |
| | `setup/unix/setup-user-dotfiles.sh` | Apply dotfiles/configs | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-dotfiles.md) | | |
| | `setup/unix/setup-user-nvchad.sh` | Install & setup NvChad for Neovim | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-nvchad.md) | | |
| | `setup/unix/setup-user-env.sh` | Setup user development environment | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-env.md) | | |
| | `setup/unix/setup-user-workspaces.sh` | Create standard workspaces directories | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-workspaces.md) | | |
| | `setup/unix/setup-user-ohmyzsh.sh` | Install Oh My Zsh & plugins | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-ohmyzsh.md) | | |
| | `setup/unix/setup-user-dotfiles.sh` | Apply dotfiles/configs | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-dotfiles.md) | | |
| | `setup/unix/setup-user-nvchad.sh` | Install & setup NvChad for Neovim | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-nvchad.md) | |
Comment on lines
+62
to
+66
| | `setup/unix/setup-user-env.sh` | Setup user development environment | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-env.md) | | ||
| | `setup/unix/setup-user-workspaces.sh` | Create standard workspaces directories | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-workspaces.md) | | ||
| | `setup/unix/setup-user-ohmyzsh.sh` | Install Oh My Zsh & plugins | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-ohmyzsh.md) | | ||
| | `setup/unix/setup-user-dotfiles.sh` | Apply dotfiles/configs | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-dotfiles.md) | | ||
| | `setup/unix/setup-user-nvchad.sh` | Install & setup NvChad for Neovim | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-nvchad.md) | |
There was a problem hiding this comment.
The documentation links still point to ./docs/runtimes/ but the script paths have been updated to setup/unix/. The documentation links should be updated to match the new script organization, likely to paths like ./docs/setup/unix/.
Suggested change
| | `setup/unix/setup-user-env.sh` | Setup user development environment | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-env.md) | | |
| | `setup/unix/setup-user-workspaces.sh` | Create standard workspaces directories | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-workspaces.md) | | |
| | `setup/unix/setup-user-ohmyzsh.sh` | Install Oh My Zsh & plugins | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-ohmyzsh.md) | | |
| | `setup/unix/setup-user-dotfiles.sh` | Apply dotfiles/configs | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-dotfiles.md) | | |
| | `setup/unix/setup-user-nvchad.sh` | Install & setup NvChad for Neovim | Unix/Linux/macOS | ❌ | [docs](./docs/runtimes/setup-user-nvchad.md) | | |
| | `setup/unix/setup-user-env.sh` | Setup user development environment | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-env.md) | | |
| | `setup/unix/setup-user-workspaces.sh` | Create standard workspaces directories | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-workspaces.md) | | |
| | `setup/unix/setup-user-ohmyzsh.sh` | Install Oh My Zsh & plugins | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-ohmyzsh.md) | | |
| | `setup/unix/setup-user-dotfiles.sh` | Apply dotfiles/configs | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-dotfiles.md) | | |
| | `setup/unix/setup-user-nvchad.sh` | Install & setup NvChad for Neovim | Unix/Linux/macOS | ❌ | [docs](./docs/setup/unix/setup-user-nvchad.md) | |
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 refactors and reorganizes the documentation for the repository's common setup scripts. The main improvements include clearer grouping of setup scripts by operating system and purpose, more consistent naming and locations for scripts, and updated usage examples with standardized argument flags. These changes make it easier for users to find the right setup scripts and understand how to use them across different platforms.
Documentation and structure improvements:
README.mdanddocs/README.mdfiles have been updated to group setup scripts by OS (Ubuntu/Debian, Linux, macOS) and by user/system scope, with new tables and clearer headings for each category. [1] [2]setup/unix/andsetup/unix/runtimes/directories for consistency. [1] [2]--runtimes=allflag instead of the previous--all-runtimesor-a, reflecting changes in script argument handling. [1] [2]docs/README.mdfor better project visibility and clarity.