Addressing PR comments - #5
Conversation
…nsion content Co-authored-by: raux <5723643+raux@users.noreply.github.com>
Claude
AI
changed the title
There was a problem hiding this comment.
Pull request overview
This PR updates the README.md to reposition BonsAIDE from a VS Code extension to a standalone web server application. The changes simplify the installation instructions by removing VS Code-specific installation methods and focusing solely on the standalone server deployment.
Changes:
- Updated product description to emphasize standalone web server functionality
- Streamlined installation section by removing VS Code extension installation options (A, B, C)
- Added API Endpoints documentation table for the HTTP server
- Fixed spelling error: TUTORAL.md → TUTORIAL.md
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Links | ||
|
|
||
| * Quick Start & Tutorial: `TUTORAL.md` | ||
| * Quick Start & Tutorial: `TUTORIAL.md` |
There was a problem hiding this comment.
The TUTORIAL.md file still describes Bonsai as a VS Code extension (references "Start Bonsai" command, VS Code prerequisites, etc.), which is inconsistent with the README's new positioning of Bonsai as a standalone web server. Consider updating TUTORIAL.md to align with the standalone web server architecture, or clarify in the README that the tutorial covers the VS Code extension usage separately.
|
|
||
| * Quick Start & Tutorial: `TUTORAL.md` | ||
| * Quick Start & Tutorial: `TUTORIAL.md` | ||
| * Repository: [https://gitlab.com/dlumbrer/bonsai-vscode](https://gitlab.com/dlumbrer/bonsai-vscode) |
There was a problem hiding this comment.
The repository URL points to GitLab (https://gitlab.com/dlumbrer/bonsai-vscode), but this appears to be a GitHub repository based on the PR context. Consider updating this URL to point to the correct repository location.
| * Repository: [https://gitlab.com/dlumbrer/bonsai-vscode](https://gitlab.com/dlumbrer/bonsai-vscode) | |
| * Repository: [https://github.com/dlumbrer/bonsai-vscode](https://github.com/dlumbrer/bonsai-vscode) |
| * macOS/Linux: `export BONSAI_LM_URL=http://localhost:1234/v1` | ||
| * Windows (PowerShell): `$env:BONSAI_LM_URL="http://localhost:1234/v1"` |
There was a problem hiding this comment.
The documentation instructs users to set BONSAI_LM_URL including the protocol (e.g., http://localhost:1234/v1), but the server code prepends http:// when making the fetch call (see src/server.ts:213). This would result in a malformed URL like http://http://localhost:1234/v1/chat/completions. Either update the documentation to omit the protocol, or modify the server code to handle URLs that already include a protocol.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.