Skip to content

Improve Getting Started Documentation to Reduce Maintenance Burden #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 7, 2025
Merged

Improve Getting Started Documentation to Reduce Maintenance Burden #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 5 additions & 29 deletions docs/getting-started/linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,11 @@ This guide will help you set up MyCoder on Linux.

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

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

# Reload shell configuration
source ~/.bashrc # or source ~/.zshrc
After installing NVM:

```bash
# Install latest LTS version of Node.js
nvm install --lts

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

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

**Ubuntu/Debian:**
```bash
# Add GitHub CLI repository
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
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

# Update package lists and install
sudo apt update
sudo apt install gh
```

**Fedora/RHEL:**
```bash
# Install from DNF repository
sudo dnf install 'dnf-command(config-manager)'
sudo dnf config-manager --add-repo https://cli.github.com/packages/rpm/gh-cli.repo
sudo dnf install gh
```

**Arch Linux:**
```bash
sudo pacman -S github-cli
```
Visit the [GitHub CLI website](https://cli.github.com/) and follow the installation instructions for your Linux distribution.

**Verify installation and authenticate:**
**After installation, verify and authenticate:**
```bash
# Verify installation
gh --version
Expand Down
22 changes: 7 additions & 15 deletions docs/getting-started/macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,11 @@ This guide will help you set up MyCoder on macOS.

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

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

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

```bash
# Verify installation
brew --version
```
Expand All @@ -35,18 +32,13 @@ This guide will help you set up MyCoder on macOS.
```bash
# Install NVM using Homebrew
brew install nvm
```

# Create NVM directory
mkdir ~/.nvm

# Add NVM configuration to your shell profile
echo 'export NVM_DIR="$HOME/.nvm"' >> ~/.zshrc
echo '[ -s "$(brew --prefix)/opt/nvm/nvm.sh" ] && \. "$(brew --prefix)/opt/nvm/nvm.sh"' >> ~/.zshrc
echo '[ -s "$(brew --prefix)/opt/nvm/etc/bash_completion.d/nvm" ] && \. "$(brew --prefix)/opt/nvm/etc/bash_completion.d/nvm"' >> ~/.zshrc
Follow the shell setup instructions provided by the NVM Homebrew installation output.

# Reload shell configuration
source ~/.zshrc
After completing the shell setup:

```bash
# Install latest LTS version of Node.js
nvm install --lts

Expand Down
12 changes: 6 additions & 6 deletions docs/getting-started/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ This guide will help you set up MyCoder on Windows.

**Recommended: Using NVM for Windows (Node Version Manager)**

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

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

After installation:

# After installation, open a new Command Prompt and install Node.js
```
# Open a new Command Prompt and install Node.js
nvm install lts

# Set it as default
Expand Down