Skip to content

[codex] Remove Conductor root from README paths#43

Merged
michaelmwu merged 1 commit into
mainfrom
michaelmwu/remove-conductor-root-readme
Jun 2, 2026
Merged

[codex] Remove Conductor root from README paths#43
michaelmwu merged 1 commit into
mainfrom
michaelmwu/remove-conductor-root-readme

Conversation

@michaelmwu

@michaelmwu michaelmwu commented Jun 2, 2026

Copy link
Copy Markdown
Member

Summary

  • Replace README examples that referenced $CONDUCTOR_ROOT_PATH with relative .gmaps-scraper/... paths.

Impact

This keeps the quickstart examples independent of Conductor-specific workspace environment variables.

Validation

  • rg -n "CONDUCTOR_ROOT_PATH" README.md returned no matches.
  • Commit hooks passed: ruff, mypy.

Summary by CodeRabbit

  • Documentation
    • Updated CLI examples to use relative local directories (.gmaps-scraper/session and .gmaps-scraper/llm-cache) instead of environment variable-based paths for session and cache storage.

Copilot AI review requested due to automatic review settings June 2, 2026 07:47
@coderabbitai

coderabbitai Bot commented Jun 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b4847ef5-c688-45a8-938b-faf32505ac42

📥 Commits

Reviewing files that changed from the base of the PR and between 01b6191 and f874a55.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

This PR updates README CLI examples to use relative local cache and session directories instead of paths derived from a $CONDUCTOR_ROOT_PATH environment variable. Both the batch scrape and LLM repair commands are updated to reference .gmaps-scraper/session and .gmaps-scraper/llm-cache respectively.

Changes

CLI Examples Documentation

Layer / File(s) Summary
Update CLI examples to use relative paths
README.md
Batch scrape command's --session-dir and LLM repair command's --llm-cache-dir are updated from $CONDUCTOR_ROOT_PATH-based locations to relative .gmaps-scraper/ directory paths.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 In docs we hop, with paths so clear,
No ENV vars to disappear,
Relative paths, local and bright,
.gmaps-scraper/ guides us right!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main change: removing Conductor root path references from README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch michaelmwu/remove-conductor-root-readme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the README quickstart examples to avoid relying on the Conductor-specific $CONDUCTOR_ROOT_PATH environment variable, making the documented commands work in any standard checkout/workspace.

Changes:

  • Replaced $CONDUCTOR_ROOT_PATH/.gmaps-scraper/... with relative .gmaps-scraper/... paths for session storage.
  • Replaced $CONDUCTOR_ROOT_PATH/.gmaps-scraper/... with relative .gmaps-scraper/... paths for LLM cache storage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@michaelmwu michaelmwu merged commit 11166c1 into main Jun 2, 2026
5 checks passed
@michaelmwu michaelmwu deleted the michaelmwu/remove-conductor-root-readme branch June 2, 2026 07:50
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