Skip to content

Commit 4dd7b49

Browse files
authored
Merge pull request #32 from drivecore/improve-getting-started-docs
Improve Getting Started Documentation to Reduce Maintenance Burden
2 parents 3f4c4be + cafac01 commit 4dd7b49

File tree

3 files changed

+18
-50
lines changed

3 files changed

+18
-50
lines changed

docs/getting-started/linux.md

+5-29
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,11 @@ This guide will help you set up MyCoder on Linux.
1616

1717
NVM is the preferred way to install Node.js as it allows for easy version management and avoids permission issues:
1818

19-
```bash
20-
# Install NVM
21-
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
19+
Visit the [NVM GitHub repository](https://github.com/nvm-sh/nvm) and follow the official installation instructions.
2220

23-
# Reload shell configuration
24-
source ~/.bashrc # or source ~/.zshrc
21+
After installing NVM:
2522

23+
```bash
2624
# Install latest LTS version of Node.js
2725
nvm install --lts
2826

@@ -54,31 +52,9 @@ This guide will help you set up MyCoder on Linux.
5452

5553
3. **GitHub CLI**: Command-line tool for interacting with GitHub
5654

57-
**Ubuntu/Debian:**
58-
```bash
59-
# Add GitHub CLI repository
60-
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
61-
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
62-
63-
# Update package lists and install
64-
sudo apt update
65-
sudo apt install gh
66-
```
67-
68-
**Fedora/RHEL:**
69-
```bash
70-
# Install from DNF repository
71-
sudo dnf install 'dnf-command(config-manager)'
72-
sudo dnf config-manager --add-repo https://cli.github.com/packages/rpm/gh-cli.repo
73-
sudo dnf install gh
74-
```
75-
76-
**Arch Linux:**
77-
```bash
78-
sudo pacman -S github-cli
79-
```
55+
Visit the [GitHub CLI website](https://cli.github.com/) and follow the installation instructions for your Linux distribution.
8056

81-
**Verify installation and authenticate:**
57+
**After installation, verify and authenticate:**
8258
```bash
8359
# Verify installation
8460
gh --version

docs/getting-started/macos.md

+7-15
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,11 @@ This guide will help you set up MyCoder on macOS.
1212

1313
Homebrew makes it easy to install and manage development tools on macOS. Installing it first will simplify the rest of the setup process.
1414

15-
```bash
16-
# Install Homebrew
17-
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
15+
Visit [brew.sh](https://brew.sh/) and follow the official installation instructions.
1816

19-
# Make sure Homebrew is in your PATH
20-
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
21-
eval "$(/opt/homebrew/bin/brew shellenv)"
17+
After installation, verify that Homebrew is working:
2218

19+
```bash
2320
# Verify installation
2421
brew --version
2522
```
@@ -35,18 +32,13 @@ This guide will help you set up MyCoder on macOS.
3532
```bash
3633
# Install NVM using Homebrew
3734
brew install nvm
35+
```
3836

39-
# Create NVM directory
40-
mkdir ~/.nvm
41-
42-
# Add NVM configuration to your shell profile
43-
echo 'export NVM_DIR="$HOME/.nvm"' >> ~/.zshrc
44-
echo '[ -s "$(brew --prefix)/opt/nvm/nvm.sh" ] && \. "$(brew --prefix)/opt/nvm/nvm.sh"' >> ~/.zshrc
45-
echo '[ -s "$(brew --prefix)/opt/nvm/etc/bash_completion.d/nvm" ] && \. "$(brew --prefix)/opt/nvm/etc/bash_completion.d/nvm"' >> ~/.zshrc
37+
Follow the shell setup instructions provided by the NVM Homebrew installation output.
4638

47-
# Reload shell configuration
48-
source ~/.zshrc
39+
After completing the shell setup:
4940

41+
```bash
5042
# Install latest LTS version of Node.js
5143
nvm install --lts
5244

docs/getting-started/windows.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ This guide will help you set up MyCoder on Windows.
1414
1515
**Recommended: Using NVM for Windows (Node Version Manager)**
1616

17-
NVM for Windows is the preferred way to install Node.js as it allows for easy version management:
17+
NVM for Windows is the preferred way to install Node.js as it allows for easy version management.
1818

19-
```
20-
# Download and install NVM for Windows
21-
# Visit: https://github.com/coreybutler/nvm-windows/releases
22-
# Download the nvm-setup.exe file from the latest release
19+
Visit [NVM for Windows releases](https://github.com/coreybutler/nvm-windows/releases) and download the latest nvm-setup.exe file.
20+
21+
After installation:
2322

24-
# After installation, open a new Command Prompt and install Node.js
23+
```
24+
# Open a new Command Prompt and install Node.js
2525
nvm install lts
2626
2727
# Set it as default

0 commit comments

Comments
 (0)