Skip to content

docs: improve environment setup clarity for new contributors#588

Closed
Kira714 wants to merge 2 commits intoaden-hive:mainfrom
Kira714:docs/improve-environment-setup-552
Closed

docs: improve environment setup clarity for new contributors#588
Kira714 wants to merge 2 commits intoaden-hive:mainfrom
Kira714:docs/improve-environment-setup-552

Conversation

@Kira714
Copy link
Contributor

@Kira714 Kira714 commented Jan 26, 2026

Summary

Fixes #552

I went through the setup process myself and hit the same pain points mentioned in the issue. This PR reorganizes ENVIRONMENT_SETUP.md to be friendlier for first-time contributors.

Changes

  • Added Prerequisites section at the top with OS compatibility table
  • Clarified optional tools - made it clear that Claude Code CLI and Docker aren't required
  • Added virtual environment instructions - especially important for Ubuntu 24.04+ where system-wide installs are blocked
  • Moved PYTHONPATH explanation earlier - now appears before you'd run into confusing errors
  • Added Windows setup notes - PowerShell examples and common issues
  • Added manual agent creation option - for folks who don't want to use Claude Code
  • Fixed hardcoded path in troubleshooting (was showing a specific user's home directory)

Test plan

  • All links in the document work
  • Instructions tested on Ubuntu with virtual environment
  • PYTHONPATH examples are correct

Generated with Claude Code

Addresses aden-hive#552 - Clarify environment setup prerequisites and PYTHONPATH usage

Changes:
- Add Prerequisites section with OS compatibility table upfront
- Clarify that Claude Code CLI and Docker are optional
- Add virtual environment setup instructions (required on Ubuntu 24.04+)
- Move PYTHONPATH explanation earlier to prevent confusion
- Add Windows-specific setup notes with PowerShell examples
- Clarify manual agent creation as alternative to Claude Code
- Fix hardcoded path in troubleshooting section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@Kira714 Kira714 force-pushed the docs/improve-environment-setup-552 branch from 79023a6 to 7e21291 Compare January 26, 2026 08:08
Copy link
Collaborator

@TimothyZhang7 TimothyZhang7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@github-actions
Copy link

PR Closed - Requirements Not Met

This PR has been automatically closed because it doesn't meet the requirements.

PR Author: @Kira714
Found issues: #552 (assignees: none)
Problem: The PR author must be assigned to the linked issue.

To fix:

  1. Assign yourself (@Kira714) to one of the linked issues
  2. Re-open this PR

Why is this required? See #472 for details.

@github-actions github-actions bot closed this Jan 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify environment setup prerequisites and PYTHONPATH usage for new contributors

2 participants