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

Documentation Improvements #16

merged 2 commits into from
Mar 7, 2025

Conversation

bhouston
Copy link
Member

@bhouston bhouston commented Mar 7, 2025

Documentation Improvements

This PR implements multiple documentation improvements:

Changes

Implementation Details

Dark Mode Removal

  • Disabled dark mode switch in Docusaurus config
  • Removed dark theme styles from CSS
  • Removed dark theme for code syntax highlighting

Logo Removal

  • Removed the logo property from navbar configuration

GitHub CLI Instructions

  • Added GitHub CLI installation instructions to all OS-specific guides:
    • Windows: Added download and installation steps
    • macOS: Added Homebrew installation method
    • Linux: Added distribution-specific installation methods

macOS Homebrew Recommendation

  • Restructured macOS guide to recommend Homebrew as the first installation step
  • Updated NVM installation to use Homebrew
  • Maintained alternative installation methods for users who prefer not to use Homebrew

Testing

  • Built the documentation site successfully
  • Verified that dark mode toggle is no longer present
  • Verified that the dinosaur logo is removed
  • Confirmed all installation instructions are clear and accurate

Screenshots

N/A - Changes are primarily textual/functional

Related Issues

bhouston added 2 commits March 7, 2025 02:06
- 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)
- Added 'mycoder config set githubMode true' instructions to all OS guides
- Explained the benefits of enabling GitHub mode
- Added verification command
@bhouston bhouston merged commit 7514eb9 into main Mar 7, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant