Skip to content

docs: Improve installation instructions with post-install steps and troubleshooting#155

Closed
visahak wants to merge 4 commits into
AgentToolkit:mainfrom
visahak:docs/improve-installation-instructions
Closed

docs: Improve installation instructions with post-install steps and troubleshooting#155
visahak wants to merge 4 commits into
AgentToolkit:mainfrom
visahak:docs/improve-installation-instructions

Conversation

@visahak
Copy link
Copy Markdown
Collaborator

@visahak visahak commented Apr 6, 2026

Problem

Users reported modes not appearing after installation because the restart requirement wasn't documented.

Changes

  • Added explicit restart requirement for Bob IDE after installation
  • Added post-installation verification steps for all platforms
  • Added troubleshooting section for common issues
  • Clarified what gets installed and where files are located
  • Updated Hello World tutorial with troubleshooting guidance

Impact

Addresses user feedback about unclear installation process and reduces support burden.

Summary by CodeRabbit

  • New Features

    • Added Codex platform integration with Evolve Lite capabilities
    • Extended sandbox environment to support both Claude Code and Codex workflows
    • Added OpenAI API key environment variable support
  • Documentation

    • New comprehensive installation and setup guides with troubleshooting sections
    • Added Codex integration documentation with configuration and workflow examples
    • Enhanced post-installation verification steps for both platforms
    • Improved skill documentation for entity extraction and error detection workflows

visahak and others added 4 commits April 6, 2026 13:56
…kerfile

- Replace separate sandbox/Dockerfile and sandbox/codex/Dockerfile with a
  single multi-stage Dockerfile (--target claude / --target codex)
- Rename sandbox-* justfile targets to claude-* for agent clarity
- Add sandbox-build/sandbox-clean with optional target param (claude/codex/all)
- Add codex-run and codex-test justfile targets
- Add sandbox/codex/entrypoint.sh and bootstrap_codex_config.py
- Merge sandbox/codex/README.md into unified sandbox/README.md
- Update docs/integrations/evolve-lite.md target references
- Add docs/integrations/evolve-lite-codex.md for Codex integration walkthrough
- Add OPENAI_API_KEY placeholder to sandbox/sample.env

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…roubleshooting

- Add explicit restart requirement for Bob IDE after installation
- Add post-installation verification steps for all platforms
- Add comprehensive troubleshooting section for common issues
- Clarify what gets installed and where files are located
- Add troubleshooting to Hello World tutorial
- Address user feedback about unclear installation process

Fixes issues reported by users where modes didn't appear after installation
because they didn't restart the IDE.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 6, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR introduces Codex IDE integration alongside existing Claude Code support. It includes multi-stage Docker builds for both platforms, adds Codex-specific bootstrap and entrypoint scripts, renames Claude-related build targets, creates new Codex targets in the justfile, expands documentation with setup and usage guides, and adds Evolve Lite Codex integration documentation.

Changes

Cohort / File(s) Summary
Documentation – Integration Guides
docs/integrations/evolve-lite-codex.md, docs/integrations/claude/evolve-lite.md
New Codex integration guide with prerequisites, installation, configuration, workflow actions, entity storage model, and capability comparison; updated Claude integration docs to use claude-prompt command.
Documentation – Installation & Examples
docs/installation/index.md, docs/examples/hello_world/bob.md
Added post-install steps, platform-specific verification, troubleshooting sections for Bob IDE and plugin verification, and clarified install script scope.
Dockerfile Multi-Stage Refactoring
sandbox/Dockerfile
Introduced shared base stage with common utilities, split into claude and codex targets; codex target installs Node.js/npm, Codex CLI, and bootstrap scripts with custom entrypoint.
Justfile Build & Run Targets
justfile
Renamed image variable to claude_image, added codex_image; renamed Claude targets (sandbox-runclaude-run, sandbox-promptclaude-prompt, sandbox-testclaude-test); added conditional build/clean targets; introduced codex-run and codex-test targets.
Codex Sandbox Setup Scripts
sandbox/codex/bootstrap_codex_config.py, sandbox/codex/entrypoint.sh
New Python script to configure Codex TOML settings (cli_auth_credentials_store, codex_hooks); new shell entrypoint to set environment variables and bootstrap config before delegating to command.
Documentation – Sandbox Usage
sandbox/README.md
Expanded scope to cover both Claude Code and Codex sandboxes; replaced direct Docker commands with just task workflow; added plugin invocation examples, authentication guidance, and external walkthrough links.
Configuration & Baseline
sandbox/sample.env, .secrets.baseline
Added OPENAI_API_KEY environment variable; updated secrets baseline with new detected entry for sample.env.
Skill Documentation
platform-integrations/codex/plugins/evolve-lite/skills/learn/SKILL.md
Shifted focus from generating guidelines to extracting proactive entities prioritizing errors/failures; added error-signals list, structured table schema, rationale field in JSON output; expanded examples and best practices.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested reviewers

  • gaodan-fang
  • illeatmyhat

Poem

🐰 hops with delight
Two IDEs now dance through Docker's stages bright,
Claude and Codex unite in the Evolve Lite light! 🌟
Bootstrap scripts whisper, entrypoints align,
Justfile targets renamed—the architecture's design! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main documentation changes: improving installation instructions with explicit post-install steps and troubleshooting guidance, which are substantive additions across multiple documentation files.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@visahak visahak closed this Apr 6, 2026
@visahak visahak deleted the docs/improve-installation-instructions branch April 27, 2026 15:38
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.

1 participant