From fcf1739def1d659088c28604bb34ff974ae61231 Mon Sep 17 00:00:00 2001 From: Ben Houston Date: Fri, 7 Mar 2025 02:06:43 -0500 Subject: [PATCH 1/2] Implement multiple documentation improvements - Remove dark mode to reduce testing requirements (fixes #11) - Remove Docusaurus dinosaur logo (fixes #14) - Add GitHub CLI installation instructions to all OS-specific guides (fixes #12) - Recommend Homebrew installation first in macOS guide (fixes #13) --- docs/getting-started/linux.md | 43 ++++++++++++++++++++++ docs/getting-started/macos.md | 65 +++++++++++++++++++++++++++++---- docs/getting-started/windows.md | 17 +++++++++ docusaurus.config.ts | 13 ++++--- src/css/custom.css | 12 ------ 5 files changed, 125 insertions(+), 25 deletions(-) diff --git a/docs/getting-started/linux.md b/docs/getting-started/linux.md index abe4779..1412210 100644 --- a/docs/getting-started/linux.md +++ b/docs/getting-started/linux.md @@ -52,6 +52,49 @@ 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. + ## Installation Install MyCoder globally using npm: diff --git a/docs/getting-started/macos.md b/docs/getting-started/macos.md index 47cbfc9..1c8958d 100644 --- a/docs/getting-started/macos.md +++ b/docs/getting-started/macos.md @@ -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. @@ -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 @@ -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 ``` @@ -43,9 +67,34 @@ 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. ## Installation diff --git a/docs/getting-started/windows.md b/docs/getting-started/windows.md index 080776e..1b735e3 100644 --- a/docs/getting-started/windows.md +++ b/docs/getting-started/windows.md @@ -40,6 +40,23 @@ 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. + ## Installation Install MyCoder globally using npm: diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 6c8decd..cb69e9a 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -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". @@ -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', @@ -164,7 +168,6 @@ const config: Config = { }, prism: { theme: prismThemes.github, - darkTheme: prismThemes.dracula, }, } satisfies Preset.ThemeConfig, }; diff --git a/src/css/custom.css b/src/css/custom.css index f63867a..e6e8151 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -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); -} From 62a5b40c9b9fc6c083e422c213f66ac44ff26495 Mon Sep 17 00:00:00 2001 From: Ben Houston Date: Fri, 7 Mar 2025 02:11:28 -0500 Subject: [PATCH 2/2] Add instructions for enabling GitHub mode in MyCoder - Added 'mycoder config set githubMode true' instructions to all OS guides - Explained the benefits of enabling GitHub mode - Added verification command --- docs/getting-started/linux.md | 14 ++++++++++++++ docs/getting-started/macos.md | 14 ++++++++++++++ docs/getting-started/windows.md | 14 ++++++++++++++ 3 files changed, 42 insertions(+) diff --git a/docs/getting-started/linux.md b/docs/getting-started/linux.md index 1412210..d8c4578 100644 --- a/docs/getting-started/linux.md +++ b/docs/getting-started/linux.md @@ -94,6 +94,20 @@ This guide will help you set up MyCoder on Linux. - 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 diff --git a/docs/getting-started/macos.md b/docs/getting-started/macos.md index 1c8958d..ce4c6bc 100644 --- a/docs/getting-started/macos.md +++ b/docs/getting-started/macos.md @@ -95,6 +95,20 @@ This guide will help you set up MyCoder on macOS. - 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 diff --git a/docs/getting-started/windows.md b/docs/getting-started/windows.md index 1b735e3..77632eb 100644 --- a/docs/getting-started/windows.md +++ b/docs/getting-started/windows.md @@ -56,6 +56,20 @@ This guide will help you set up MyCoder on Windows. - 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