docs: add setup guide and fix TypeScript configuration - #2
docs: add setup guide and fix TypeScript configuration#2openroomote-bruno[bot] wants to merge 1 commit into
Conversation
Review completed. Found 4 issues that should be addressed:
Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues. |
Review complete. The TypeScript configuration fix and added dependency are solid. Found a few documentation issues in the new SETUP_COMPLETE.md file that should be addressed for better portability and user experience.
Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues. |
|
|
||
| ```bash | ||
| cd VERT | ||
| ~/.bun/bin/bun dev |
There was a problem hiding this comment.
Hardcoded Bun path won't work for all users. This assumes Bun was installed in ~/.bun/bin/, but users who installed via npm, package managers (apt, brew), or custom locations will encounter command-not-found errors. The existing documentation in GETTING_STARTED.md correctly uses just bun which works regardless of installation method.
| ~/.bun/bin/bun dev | |
| bun dev |
Fix it with Roo Code or mention @roomote and request a fix.
|
|
||
| ```bash | ||
| cd VERT | ||
| ~/.bun/bin/bun run build |
There was a problem hiding this comment.
Hardcoded Bun path won't work for all users. This assumes Bun was installed in ~/.bun/bin/, but users who installed via npm, package managers (apt, brew), or custom locations will encounter command-not-found errors. Use just bun to work with any installation method.
| ~/.bun/bin/bun run build | |
| bun run build |
Fix it with Roo Code or mention @roomote and request a fix.
| - **Type checking**: `~/.bun/bin/bun run check` | ||
| - **Linting**: `~/.bun/bin/bun run lint` | ||
| - **Format code**: `~/.bun/bin/bun run format` | ||
| - **Preview production build**: `~/.bun/bin/bun run preview` |
There was a problem hiding this comment.
Hardcoded Bun paths in all commands won't work for users who installed Bun via npm, package managers, or custom locations. Use just bun to work with any installation method, consistent with the existing documentation.
| - **Type checking**: `~/.bun/bin/bun run check` | |
| - **Linting**: `~/.bun/bin/bun run lint` | |
| - **Format code**: `~/.bun/bin/bun run format` | |
| - **Preview production build**: `~/.bun/bin/bun run preview` | |
| - **Type checking**: `bun run check` | |
| - **Linting**: `bun run lint` | |
| - **Format code**: `bun run format` | |
| - **Preview production build**: `bun run preview` |
Fix it with Roo Code or mention @roomote and request a fix.
| # VERT Application Setup Complete | ||
|
|
||
| ## What Was Done | ||
|
|
||
| The VERT application has been successfully set up and is ready to run: | ||
|
|
||
| 1. ✅ Installed Bun v1.3.6 (JavaScript runtime and package manager) | ||
| 2. ✅ Created `.env` configuration file from `.env.example` | ||
| 3. ✅ Installed all project dependencies (366 packages) | ||
| 4. ✅ Added `@types/node` for TypeScript definitions | ||
| 5. ✅ Compiled paraglide internationalization messages | ||
| 6. ✅ Verified setup with `bun run check` - 0 errors found |
There was a problem hiding this comment.
Document framing doesn't match its intended purpose. The PR describes this as a "setup guide" but the content reads like a post-setup completion report with past tense ("What Was Done", "has been successfully set up") and specific instance details (Bun v1.3.6, 366 packages). This creates confusion about whether users should follow it as instructions or if it's a template for completion reports. Consider reframing with imperative instructions ("Install Bun", "Create .env file") or renaming to clarify it's documentation of a completed setup rather than a guide.
Fix it with Roo Code or mention @roomote and request a fix.
| ```bash | ||
| cd VERT | ||
| ~/.bun/bin/bun dev | ||
| ``` |
There was a problem hiding this comment.
This cd VERT command assumes the user is outside the VERT directory. Since this documentation file lives inside the VERT repository itself, users following the setup will already be in the VERT directory. The command would fail or cause confusion. Consider removing the cd VERT line or making it conditional ("If you're not already in the VERT directory...").
Fix it with Roo Code or mention @roomote and request a fix.
| ```bash | ||
| cd VERT | ||
| ~/.bun/bin/bun run build | ||
| ``` |
There was a problem hiding this comment.
Same issue here - the cd VERT command assumes the user is outside the VERT directory. Users reading this documentation are likely already inside the repository, making this command unnecessary or potentially confusing.
Fix it with Roo Code or mention @roomote and request a fix.
|
|
||
| ```bash | ||
| cd VERT | ||
| ~/.bun/bin/bun dev |
There was a problem hiding this comment.
Hardcoded path to ~/.bun/bin/bun assumes a specific Bun installation location. Most users will have Bun in their PATH and can simply use bun dev. The existing GETTING_STARTED.md uses the simpler bun command without a path. This hardcoded path may not work for users with different Bun installations (system-wide, via package managers, different shells, etc.).
Fix it with Roo Code or mention @roomote and request a fix.
| - **Type checking**: `~/.bun/bin/bun run check` | ||
| - **Linting**: `~/.bun/bin/bun run lint` | ||
| - **Format code**: `~/.bun/bin/bun run format` | ||
| - **Preview production build**: `~/.bun/bin/bun run preview` |
There was a problem hiding this comment.
Same hardcoded path issue applies to all these commands. Using bun run check, bun run lint, etc. would be more portable and consistent with the existing documentation. The hardcoded ~/.bun/bin/bun path assumes a specific installation method that may not match all users' setups.
Fix it with Roo Code or mention @roomote and request a fix.
This PR adds comprehensive setup documentation and fixes TypeScript configuration issues.
Changes
@types/nodedependency to fix TypeScript errors related tochild_process,process, andNodeJSnamespaceSETUP_COMPLETE.mdwith detailed setup instructions and usage guidepackage.jsonandbun.lockwith the new dependencyBenefits
Testing
bun run check)View task on Roo Code Cloud