docs: Improve installation instructions with post-install steps and troubleshooting - #156
docs: Improve installation instructions with post-install steps and troubleshooting#156visahak wants to merge 3 commits into
Conversation
|
Warning Rate limit exceeded
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 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 configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
docs/examples/hello_world/bob.mddocs/installation/index.md
…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.
|
Closing the issue since those changes already happened in another PR. cc: @illeatmyhat |
Problem
Users reported modes not appearing after installation because the restart requirement wasn't documented.
Changes
Impact
Addresses user feedback about unclear installation process and reduces support burden.
Summary by CodeRabbit