Skip to content

Documentation Improvements #16

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.

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 2 commits into from
Mar 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 57 additions & 0 deletions docs/getting-started/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,63 @@ This guide will help you set up MyCoder on Linux.
- Fedora/RHEL: `sudo yum install git`
- Verify with `git --version`

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
```

**Verify installation and authenticate:**
```bash
# Verify installation
gh --version

# Authenticate with GitHub
gh auth login
```

The GitHub CLI makes it easy to:
- Create and manage issues
- Create and review pull requests
- Clone repositories
- Manage GitHub workflows

This is especially useful if you plan to contribute to MyCoder or related projects.

**Enable GitHub Mode in MyCoder**:

After installing the GitHub CLI, enable GitHub mode in MyCoder for enhanced GitHub integration:

```bash
# Enable GitHub mode
mycoder config set githubMode true

# Verify configuration
mycoder config get githubMode
```

With GitHub mode enabled, MyCoder can create issues, branches, and pull requests directly through the GitHub CLI.

## Installation

Install MyCoder globally using npm:
Expand Down
79 changes: 71 additions & 8 deletions docs/getting-started/macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,23 @@ This guide will help you set up MyCoder on macOS.

## Prerequisites

1. **Node.js**: Install Node.js version 20.0.0 or higher
1. **Homebrew**: The recommended package manager for 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)"

# Make sure Homebrew is in your PATH
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
eval "$(/opt/homebrew/bin/brew shellenv)"

# Verify installation
brew --version
```

2. **Node.js**: Install Node.js version 20.0.0 or higher

> **⚠️ Important:** MyCoder requires Node.js runtime to function properly.

Expand All @@ -17,11 +33,19 @@ This guide will help you set up MyCoder on macOS.
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
# 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

# Reload shell configuration
source ~/.zshrc # or source ~/.bash_profile for older macOS versions
source ~/.zshrc

# Install latest LTS version of Node.js
nvm install --lts
Expand All @@ -33,7 +57,7 @@ This guide will help you set up MyCoder on macOS.
node --version
```

**Alternative: Using Homebrew:**
**Alternative: Direct Homebrew installation:**
```bash
brew install node
```
Expand All @@ -43,9 +67,48 @@ This guide will help you set up MyCoder on macOS.

Verify installation with `node --version`

2. **Git**: macOS typically comes with Git pre-installed
- Verify with `git --version`
- If not installed: `brew install git`
3. **Git**: Version control system
```bash
# Install Git using Homebrew
brew install git

# Verify installation
git --version
```

4. **GitHub CLI**: Command-line tool for interacting with GitHub
```bash
# Install GitHub CLI using Homebrew
brew install gh

# Verify installation
gh --version

# Authenticate with GitHub
gh auth login
```

The GitHub CLI makes it easy to:
- Create and manage issues
- Create and review pull requests
- Clone repositories
- Manage GitHub workflows

This is especially useful if you plan to contribute to MyCoder or related projects.

**Enable GitHub Mode in MyCoder**:

After installing the GitHub CLI, enable GitHub mode in MyCoder for enhanced GitHub integration:

```bash
# Enable GitHub mode
mycoder config set githubMode true

# Verify configuration
mycoder config get githubMode
```

With GitHub mode enabled, MyCoder can create issues, branches, and pull requests directly through the GitHub CLI.

## Installation

Expand Down
31 changes: 31 additions & 0 deletions docs/getting-started/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,37 @@ This guide will help you set up MyCoder on Windows.
- Download from [git-scm.com](https://git-scm.com/download/win)
- Verify installation with `git --version`

3. **GitHub CLI**: Command-line tool for interacting with GitHub
- Download from [cli.github.com](https://cli.github.com/)
- Run the installer and follow the prompts
- Verify installation with `gh --version`
- Authenticate with GitHub:
```
gh auth login
```

The GitHub CLI makes it easy to:
- Create and manage issues
- Create and review pull requests
- Clone repositories
- Manage GitHub workflows

This is especially useful if you plan to contribute to MyCoder or related projects.

**Enable GitHub Mode in MyCoder**:

After installing the GitHub CLI, enable GitHub mode in MyCoder for enhanced GitHub integration:

```
# Enable GitHub mode
mycoder config set githubMode true

# Verify configuration
mycoder config get githubMode
```

With GitHub mode enabled, MyCoder can create issues, branches, and pull requests directly through the GitHub CLI.

## Installation

Install MyCoder globally using npm:
Expand Down
13 changes: 8 additions & 5 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ const config: Config = {
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',

// Disable dark mode
themeConfig: {
colorMode: {
disableSwitch: true,
defaultMode: 'light',
},
},

// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
Expand Down Expand Up @@ -84,10 +92,6 @@ const config: Config = {
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'MyCoder Docs',
logo: {
alt: 'MyCoder Logo',
src: 'img/logo.svg',
},
items: [
{
type: 'docSidebar',
Expand Down Expand Up @@ -164,7 +168,6 @@ const config: Config = {
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
};
Expand Down
12 changes: 0 additions & 12 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,3 @@
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #ffffff;
--ifm-color-primary-dark: #e6e6e6;
--ifm-color-primary-darker: #d9d9d9;
--ifm-color-primary-darkest: #b3b3b3;
--ifm-color-primary-light: #ffffff;
--ifm-color-primary-lighter: #ffffff;
--ifm-color-primary-lightest: #ffffff;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}