Skip to content

docs: add guide for venv usage#307

Merged
tirth8205 merged 1 commit intotirth8205:mainfrom
Aadish01:docs/add-guide-for-venv-usage
Apr 18, 2026
Merged

docs: add guide for venv usage#307
tirth8205 merged 1 commit intotirth8205:mainfrom
Aadish01:docs/add-guide-for-venv-usage

Conversation

@Aadish01
Copy link
Copy Markdown
Contributor

@Aadish01 Aadish01 commented Apr 17, 2026

Update Troubleshooting Guide for Virtual Environment Usage

Summary

This PR enhances the troubleshooting documentation by adding guidance for users working with Python virtual environments and MCP configuration.

Changes

  • Added a new section explaining issues when switching to or using a virtual environment after running code-review-graph install

  • Documented that .claude/settings.json and .mcp.json contain hardcoded paths determined at install time

  • Provided two resolution approaches:

    • Manually updating paths in configuration files
    • Re-running code-review-graph install within the active virtual environment
  • Included an example configuration snippet for clarity

  • Renumbered the subsequent troubleshooting section accordingly

Rationale

Users working with virtual environments may encounter silent failures due to outdated interpreter paths in MCP and hook configurations. This addition clarifies the root cause and provides actionable fixes, reducing setup friction.

Impact

  • Documentation-only change
  • Improves developer experience for users leveraging virtual environments
  • No impact on runtime behavior or existing functionality

Testing

No tests required as this is a documentation update.


@tirth8205 tirth8205 merged commit cbd77dc into tirth8205:main Apr 18, 2026
1 check 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

Development

Successfully merging this pull request may close these issues.

2 participants