Skip to content

Commit 7514eb9

Browse files
bhoustonbhouston
authored
Merge pull request #16 from drivecore/docs-improvements
Documentation Improvements
2 parents 45ceed6 + 62a5b40 commit 7514eb9

File tree

5 files changed

+167
-25
lines changed

5 files changed

+167
-25
lines changed

‎docs/getting-started/linux.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,63 @@ This guide will help you set up MyCoder on Linux.
5252
- Fedora/RHEL: `sudo yum install git`
5353
- Verify with `git --version`
5454

55+
3. **GitHub CLI**: Command-line tool for interacting with GitHub
56+
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+
```
80+
81+
**Verify installation and authenticate:**
82+
```bash
83+
# Verify installation
84+
gh --version
85+
86+
# Authenticate with GitHub
87+
gh auth login
88+
```
89+
90+
The GitHub CLI makes it easy to:
91+
- Create and manage issues
92+
- Create and review pull requests
93+
- Clone repositories
94+
- Manage GitHub workflows
95+
96+
This is especially useful if you plan to contribute to MyCoder or related projects.
97+
98+
**Enable GitHub Mode in MyCoder**:
99+
100+
After installing the GitHub CLI, enable GitHub mode in MyCoder for enhanced GitHub integration:
101+
102+
```bash
103+
# Enable GitHub mode
104+
mycoder config set githubMode true
105+
106+
# Verify configuration
107+
mycoder config get githubMode
108+
```
109+
110+
With GitHub mode enabled, MyCoder can create issues, branches, and pull requests directly through the GitHub CLI.
111+
55112
## Installation
56113

57114
Install MyCoder globally using npm:

‎docs/getting-started/macos.md‎

Lines changed: 71 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,23 @@ This guide will help you set up MyCoder on macOS.
88

99
## Prerequisites
1010

11-
1. **Node.js**: Install Node.js version 20.0.0 or higher
11+
1. **Homebrew**: The recommended package manager for macOS
12+
13+
Homebrew makes it easy to install and manage development tools on macOS. Installing it first will simplify the rest of the setup process.
14+
15+
```bash
16+
# Install Homebrew
17+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
18+
19+
# Make sure Homebrew is in your PATH
20+
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile
21+
eval "$(/opt/homebrew/bin/brew shellenv)"
22+
23+
# Verify installation
24+
brew --version
25+
```
26+
27+
2. **Node.js**: Install Node.js version 20.0.0 or higher
1228

1329
> **⚠️ Important:** MyCoder requires Node.js runtime to function properly.
1430
@@ -17,11 +33,19 @@ This guide will help you set up MyCoder on macOS.
1733
NVM is the preferred way to install Node.js as it allows for easy version management and avoids permission issues:
1834

1935
```bash
20-
# Install NVM
21-
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
36+
# Install NVM using Homebrew
37+
brew install nvm
38+
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
2246

2347
# Reload shell configuration
24-
source ~/.zshrc # or source ~/.bash_profile for older macOS versions
48+
source ~/.zshrc
2549

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

36-
**Alternative: Using Homebrew:**
60+
**Alternative: Direct Homebrew installation:**
3761
```bash
3862
brew install node
3963
```
@@ -43,9 +67,48 @@ This guide will help you set up MyCoder on macOS.
4367

4468
Verify installation with `node --version`
4569

46-
2. **Git**: macOS typically comes with Git pre-installed
47-
- Verify with `git --version`
48-
- If not installed: `brew install git`
70+
3. **Git**: Version control system
71+
```bash
72+
# Install Git using Homebrew
73+
brew install git
74+
75+
# Verify installation
76+
git --version
77+
```
78+
79+
4. **GitHub CLI**: Command-line tool for interacting with GitHub
80+
```bash
81+
# Install GitHub CLI using Homebrew
82+
brew install gh
83+
84+
# Verify installation
85+
gh --version
86+
87+
# Authenticate with GitHub
88+
gh auth login
89+
```
90+
91+
The GitHub CLI makes it easy to:
92+
- Create and manage issues
93+
- Create and review pull requests
94+
- Clone repositories
95+
- Manage GitHub workflows
96+
97+
This is especially useful if you plan to contribute to MyCoder or related projects.
98+
99+
**Enable GitHub Mode in MyCoder**:
100+
101+
After installing the GitHub CLI, enable GitHub mode in MyCoder for enhanced GitHub integration:
102+
103+
```bash
104+
# Enable GitHub mode
105+
mycoder config set githubMode true
106+
107+
# Verify configuration
108+
mycoder config get githubMode
109+
```
110+
111+
With GitHub mode enabled, MyCoder can create issues, branches, and pull requests directly through the GitHub CLI.
49112

50113
## Installation
51114

‎docs/getting-started/windows.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,37 @@ This guide will help you set up MyCoder on Windows.
4040
- Download from [git-scm.com](https://git-scm.com/download/win)
4141
- Verify installation with `git --version`
4242

43+
3. **GitHub CLI**: Command-line tool for interacting with GitHub
44+
- Download from [cli.github.com](https://cli.github.com/)
45+
- Run the installer and follow the prompts
46+
- Verify installation with `gh --version`
47+
- Authenticate with GitHub:
48+
```
49+
gh auth login
50+
```
51+
52+
The GitHub CLI makes it easy to:
53+
- Create and manage issues
54+
- Create and review pull requests
55+
- Clone repositories
56+
- Manage GitHub workflows
57+
58+
This is especially useful if you plan to contribute to MyCoder or related projects.
59+
60+
**Enable GitHub Mode in MyCoder**:
61+
62+
After installing the GitHub CLI, enable GitHub mode in MyCoder for enhanced GitHub integration:
63+
64+
```
65+
# Enable GitHub mode
66+
mycoder config set githubMode true
67+
68+
# Verify configuration
69+
mycoder config get githubMode
70+
```
71+
72+
With GitHub mode enabled, MyCoder can create issues, branches, and pull requests directly through the GitHub CLI.
73+
4374
## Installation
4475
4576
Install MyCoder globally using npm:

‎docusaurus.config.ts‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ const config: Config = {
2323
onBrokenLinks: 'throw',
2424
onBrokenMarkdownLinks: 'warn',
2525

26+
// Disable dark mode
27+
themeConfig: {
28+
colorMode: {
29+
disableSwitch: true,
30+
defaultMode: 'light',
31+
},
32+
},
33+
2634
// Even if you don't use internationalization, you can use this field to set
2735
// useful metadata like html lang. For example, if your site is Chinese, you
2836
// may want to replace "en" with "zh-Hans".
@@ -84,10 +92,6 @@ const config: Config = {
8492
image: 'img/docusaurus-social-card.jpg',
8593
navbar: {
8694
title: 'MyCoder Docs',
87-
logo: {
88-
alt: 'MyCoder Logo',
89-
src: 'img/logo.svg',
90-
},
9195
items: [
9296
{
9397
type: 'docSidebar',
@@ -164,7 +168,6 @@ const config: Config = {
164168
},
165169
prism: {
166170
theme: prismThemes.github,
167-
darkTheme: prismThemes.dracula,
168171
},
169172
} satisfies Preset.ThemeConfig,
170173
};

‎src/css/custom.css‎

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,3 @@
1616
--ifm-code-font-size: 95%;
1717
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
1818
}
19-
20-
/* For readability concerns, you should choose a lighter palette in dark mode. */
21-
[data-theme='dark'] {
22-
--ifm-color-primary: #ffffff;
23-
--ifm-color-primary-dark: #e6e6e6;
24-
--ifm-color-primary-darker: #d9d9d9;
25-
--ifm-color-primary-darkest: #b3b3b3;
26-
--ifm-color-primary-light: #ffffff;
27-
--ifm-color-primary-lighter: #ffffff;
28-
--ifm-color-primary-lightest: #ffffff;
29-
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
30-
}

0 commit comments

Comments
 (0)