Skip to content

Improve Getting Started Documentation to Reduce Maintenance Burden #29

@bhouston

Description

@bhouston

Improve Getting Started Documentation to Reduce Maintenance Burden

Description

This issue proposes changes to the platform-specific setup documentation to reduce maintenance burden by linking to external resources for installation instructions rather than duplicating them. This approach will help prevent our documentation from becoming outdated when third-party tools update their installation procedures.

Proposed Changes

macOS Setup Improvements

  1. For Homebrew installation:

    • Link to the official Homebrew website (https://brew.sh/)
    • Recommend users install it rather than duplicating the installation instructions
    • Remove the current code block with detailed installation steps
  2. For NVM installation:

    • Remove the "Create NVM Directory", "Add NVM configuration to your shell profile", and "reload shell configuration" instructions
    • Replace with a simple instruction to "follow instructions from NVM for shell setup"
    • Keep the installation and usage commands (nvm install --lts, etc.)

Linux Setup Improvements

  1. For NVM installation:

    • Link to the official NVM GitHub repository (https://github.com/nvm-sh/nvm)
    • Ask users to follow official installation instructions rather than duplicating them
    • Keep the usage commands (nvm install --lts, etc.)
  2. For GitHub CLI installation:

    • Link to the official GitHub CLI page (https://cli.github.com/)
    • Ask users to follow platform-specific installation instructions
    • Keep the verification and authentication steps (gh --version and gh auth login)

Windows Setup Improvements

  1. For NVM for Windows installation:
    • Move the link to NVM for Windows (https://github.com/coreybutler/nvm-windows) outside of the code block to make it clickable
    • Simplify instructions to direct users to follow the official documentation
    • Keep the usage commands (nvm install lts, etc.)

Benefits

  • Reduces maintenance burden as we won't need to update our docs when third-party tools change their installation procedures
  • Ensures users always get the most up-to-date installation instructions
  • Maintains focus on MyCoder-specific setup while delegating standard tool installations to their respective maintainers

Implementation Notes

  • All links should be proper markdown links outside of code blocks to ensure they're clickable
  • We should still maintain the verification steps to ensure users have correctly installed the required tools
  • The changes should preserve all MyCoder-specific instructions while only removing duplicated third-party installation steps

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions