Skip to content

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

Closed
visahak wants to merge 3 commits into
AgentToolkit:mainfrom
visahak:fix-docs
Closed

docs: Improve installation instructions with post-install steps and troubleshooting#156
visahak wants to merge 3 commits into
AgentToolkit:mainfrom
visahak:fix-docs

Conversation

@visahak

@visahak visahak commented Apr 6, 2026

Copy link
Copy Markdown
Collaborator

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

  • Documentation
    • Enhanced Bob IDE setup instructions with explicit restart steps and mode selection guidance
    • Added comprehensive post-installation checklist with platform-specific verification steps for Bob, Claude Code, and Codex
    • Introduced troubleshooting section addressing common installation issues and missing modes

@coderabbitai

coderabbitai Bot commented Apr 6, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@visahak has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 15 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 11 minutes and 15 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: be4218dc-597f-4247-9709-61fedb0f4b1c

📥 Commits

Reviewing files that changed from the base of the PR and between b6e5dd6 and 8745de1.

📒 Files selected for processing (2)
  • docs/examples/hello_world/bob.md
  • docs/installation/index.md
📝 Walkthrough

Walkthrough

Documentation updates were made to Bob IDE setup and installation instructions. The tutorial file now provides detailed restart requirements, step-by-step UI navigation steps, and troubleshooting procedures. The installation guide adds comprehensive post-installation guidance covering what's installed, verification steps, and common issues.

Changes

Cohort / File(s) Summary
Bob IDE Installation Documentation
docs/examples/hello_world/bob.md, docs/installation/index.md
Expanded Bob IDE setup instructions with explicit restart requirements after Evolve installation, detailed UI navigation steps for mode selection, and troubleshooting checklist. Added post-installation section covering mode configuration file locations, verification steps across platforms (Bob, Claude Code, Codex), and common issues with resolutions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • illeatmyhat
  • vinodmut

Poem

🐰 A rabbit's ode to clearer docs:

Through Bob's IDE the users hop,
With guides so clear, they'll never stop,
Restart steps and checks so neat,
Troubleshooting's now a treat! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: documentation improvements focused on installation instructions, post-install steps, and troubleshooting guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 requested review from illeatmyhat and vinodmut April 6, 2026 19:50

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/examples/hello_world/bob.md`:
- Line 36: Update the troubleshooting text that currently refers to
"~/.bob/settings/custom_modes.yaml" so it uses the correct installer target path
"~/.bob/custom_modes.yaml"; locate the string in the hello_world documentation
(bob.md) and replace the incorrect path text, ensuring any surrounding
explanatory sentence still reads correctly and references the evolve-lite
configuration file at "~/.bob/custom_modes.yaml".

In `@docs/installation/index.md`:
- Line 17: Replace all occurrences of the incorrect path string
"~/.bob/settings/custom_modes.yaml" in docs/installation/index.md with the
correct installer output path "~/.bob/custom_modes.yaml" (this fixes the
verification steps that currently point to the wrong file); update the three
other instances noted (near the current lines 63, 67, and 106-108) so all
verification/troubleshooting references consistently use the corrected path
string.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 631bc775-0ee1-420b-bc53-692f2cb5074c

📥 Commits

Reviewing files that changed from the base of the PR and between a532870 and b6e5dd6.

📒 Files selected for processing (2)
  • docs/examples/hello_world/bob.md
  • docs/installation/index.md

Comment thread docs/examples/hello_world/bob.md Outdated
Comment thread docs/installation/index.md Outdated
visahak added 2 commits April 7, 2026 08:45
…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.
@visahak

visahak commented Apr 7, 2026

Copy link
Copy Markdown
Collaborator Author

Closing the issue since those changes already happened in another PR. cc: @illeatmyhat

@visahak visahak closed this Apr 7, 2026
@visahak
visahak deleted the fix-docs 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