docs: expand troubleshooting guide section in main README#733
Conversation
📝 WalkthroughWalkthroughThe README gains a new Troubleshooting section that documents how to resolve build cache and dependency synchronization issues in the monorepo by running ChangesTroubleshooting Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 468-471: Update the README.md near the bash snippet containing
"bun run clean" / "bun install" to explicitly state that "bun install" must be
run from the monorepo root (not from inside a package) to ensure dependency
sync; add a one-line note either above the code block or as an inline comment in
the block clarifying "Run `bun install` from the repo root, never from inside a
package." so contributors know where to execute the commands.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ```bash | ||
| bun run clean | ||
| bun install | ||
| ``` |
There was a problem hiding this comment.
Specify that bun install must be run from the repository root.
Please add a short note here (or inline in the code block) that this command sequence must be executed from the monorepo root, otherwise dependency sync may still fail for contributors running it inside a package.
Based on learnings: “Run bun install from the repo root, never from inside a package.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 468 - 471, Update the README.md near the bash snippet
containing "bun run clean" / "bun install" to explicitly state that "bun
install" must be run from the monorepo root (not from inside a package) to
ensure dependency sync; add a one-line note either above the code block or as an
inline comment in the block clarifying "Run `bun install` from the repo root,
never from inside a package." so contributors know where to execute the
commands.
Closes #732
Summary by CodeRabbit